8000 [docs] Sort dependencies in README.Ubuntu.md by garbear · Pull Request #26841 · xbmc/xbmc · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[docs] Sort dependencies in README.Ubuntu.md #26841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[docs] Sort dependencies in README.Ubuntu.md #26841

wants to merge 2 commits into from

Conversation

garbear
Copy link
Member
@garbear garbear commented Jun 5, 2025 •
edited
Loading

Description

As title says, this sorts dependencies in README.Ubuntu.md.

Sorted using a combination of macros and sorting inside of Sublime.

Motivation and context

Unsorted dependencies were highlighted in a past PR.

I'm working on RetroPlayer builds with new dependencies, so a sorted list will be an improvement.

How has this been tested?

Ran apt command on ubuntu 24.04. Successful output:

0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded.

In one of my RetroPlayer commits, I add LMDB. Here's what the diff looks like, with no extra effort to "rebalance":

diff --git a/docs/README.Ubuntu.md b/docs/README.Ubuntu.md
index 618202aeb6..ade095bdb6 100644
--- a/docs/README.Ubuntu.md
+++ b/docs/README.Ubuntu.md
@@ -135,7 +135,7 @@ sudo apt install autoconf automake autopoint autotools-dev cmake \
   libfmt-dev libfontconfig-dev libfreetype6-dev libfribidi-dev \
   libfstrcmp-dev libgcrypt-dev libgif-dev libgl1-mesa-dev \
   libgles2-mesa-dev libglu1-mesa-dev libgnutls28-dev libgpg-error-dev \
-  libgtest-dev libiso9660-dev libjpeg-dev liblcms2-dev libltdl-dev \
+  libgtest-dev libiso9660-dev libjpeg-dev liblcms2-dev liblmdb-dev libltdl-dev \
   liblzo2-dev libmicrohttpd-dev libmysqlclient-dev libnfs-dev \
   libogg-dev libp8-platform-dev libpcre2-dev libplist-dev libpng-dev \
   libpulse-dev libshairplay-dev libsmbclient-dev libspdlog-dev \

Makes the diff much more readable.

What is the effect on users?

  • None

Types of change

  • Bug fix (non-breaking change which fixes an issue)
  • Clean up (non-breaking change which removes non-working, unmaintained functionality)
  • Improvement (non-breaking change which improves existing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that will cause existing functionality to change)
  • Cosmetic change (non-breaking change that doesn't touch code)
  • Student submission (PR was done for educational purposes and will be treated as such)
  • None of the above (please explain below)

@garbear garbear requested a review from Copilot June 5, 2025 05:45
Copilot
Copilot AI reviewed Jun 5, 2025
View reviewed changes
Copy link
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR sorts the list of Ubuntu package dependencies in README.Ubuntu.md into alphabetical order for improved readability and maintenance.

  • Reordered the apt install arguments alphabetically.
  • Replaced the single unsorted command with the sorted version.
Comments suppressed due to low confidence (2)

docs/README.Ubuntu.md:129

  • [nitpick] The apt install command is extremely long; consider breaking it into multiple lines with backslashes (\) to improve readability and maintainability.
sudo apt install autoconf automake autopoint autotools-dev cmake curl debhelper default-jre doxygen gawk gcc gdc gettext gperf libasound2-dev libass-dev libavahi-client-dev libavahi-common-dev libbluetooth-dev libbluray-dev libbz2-dev libcdio-dev libcrossguid-dev libcurl4-openssl-dev libcwiid-dev libdbus-1-dev libdrm-dev libegl1-mesa-dev libenca-dev libexiv2-dev libflac-dev libfmt-dev libfontconfig-dev libfreetype6-dev libfribidi-dev libfstrcmp-dev libgcrypt-dev libgif-dev libgl1-mesa-dev libgles2-mesa-dev libglu1-mesa-dev libgnutls28-dev libgpg-error-dev libgtest-dev libiso9660-dev libjpeg-dev liblcms2-dev libltdl-dev liblzo2-dev libmicrohttpd-dev libmysqlclient-dev libnfs-dev libogg-dev libp8-platform-dev libpcre2-dev libplist-dev libpng-dev libpulse-dev libshairplay-dev libsmbclient-dev libspdlog-dev libsqlite3-dev libssl-dev libtag1-dev libtiff5-dev libtinyxml-dev libtinyxml2-dev libtool libudev-dev libunistring-dev libva-dev libvdpau-dev libvorbis-dev libxmu-dev libxrandr-dev libxslt1-dev libxt-dev lsb-release meson nasm ninja-build nlohmann-json3-dev python3-dev python3-pil python3-pip swig unzip uuid-dev zip zlib1g-dev

docs/README.Ubuntu.md:129

  • To avoid interactive prompts and reduce installation of recommended packages, consider adding -y --no-install-recommends to the apt install command.
sudo apt install autoconf automake autopoint autotools-dev cmake curl debhelper default-jre doxygen gawk gcc gdc gettext gperf libasound2-dev libass-dev libavahi-client-dev libavahi-common-dev libbluetooth-dev libbluray-dev libbz2-dev libcdio-dev libcrossguid-dev libcurl4-openssl-dev libcwiid-dev libdbus-1-dev libdrm-dev libegl1-mesa-dev libenca-dev libexiv2-dev libflac-dev libfmt-dev libfontconfig-dev libfreetype6-dev libfribidi-dev libfstrcmp-dev libgcrypt-dev libgif-dev libgl1-mesa-dev libgles2-mesa-dev libglu1-mesa-dev libgnutls28-dev libgpg-error-dev libgtest-dev libiso9660-dev libjpeg-dev liblcms2-dev libltdl-dev liblzo2-dev libmicrohttpd-dev libmysqlclient-dev libnfs-dev libogg-dev libp8-platform-dev libpcre2-dev libplist-dev libpng-dev libpulse-dev libshairplay-dev libsmbclient-dev libspdlog-dev libsqlite3-dev libssl-dev libtag1-dev libtiff5-dev libtinyxml-dev libtinyxml2-dev libtool libudev-dev libunistring-dev libva-dev libvdpau-dev libvorbis-dev libxmu-dev libxrandr-dev libxslt1-dev libxt-dev lsb-release meson nasm ninja-build nlohmann-json3-dev python3-dev python3-pil python3-pip swig unzip uuid-dev zip zlib1g-dev

@garbear garbear added Type: Improvement non-breaking change which improves existing functionality Documentation Component: Documentation v22 Piers labels Jun 5, 2025
@garbear garbear added this to the Piers 22.0 Alpha 1 milestone Jun 5, 2025
@garbear
Copy link
Member Author
garbear commented Jun 5, 2025 •
edited
Loading

I used Codex to wrap at 76 chars, per Copilot's recommendation. Makes the diff more readable when a dependency is added. And Codex makes it easy to "rebalance" in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

Assignees
No one assigned
Labels
Component: Documentation Documentation Type: Improvement non-breaking change which improves existing functionality v22 Piers
Projects
None yet
Milestone
Piers 22.0 Alpha 1
Development

Successfully merging this pull request may close these issues.
1 participant
@garbear
0