build: Enable changing the completion paths & drop install_completions #1123
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Sep 12, 2022
There's no well-defined use-case for having a build option for generating and installing the shell completions. The bash-completion and fish dependencies are already optional, and there's no dependency required for Z shell. The shell completions for Bash and fish won't be generated and installed if they are absent. So the build option isn't reducing the dependency burden. The build option is a way to disable the generation and installation of the shell completions, regardless of whether the necessary dependencies are present or not. There's no well-defined use-case for that. Fallout from bafbbe8 containers#1123 containers#840
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Sep 12, 2022
Names like bash_comp_dir and fish_comp_dir get missed when grepping for 'completion'. Note that the name of the directory is a plural, because it contains lots of completions for many different programs, just like the name of the pkgconfig variable. containers#1123
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Sep 12, 2022
Fallout from bafbbe8 containers#1123
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Sep 12, 2022
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Sep 12, 2022
This is particularly relevant for Z shell, because, unlike Bash's
bash-completion.pc and fish's fish.pc, it doesn't have an API to detect
the location for the shell completions and Debian and Fedora use
different locations [1, 2]. Namely, /usr/share/zsh/vendor-completions
and /usr/share/zsh/site-functions.
An option to specify the locations for the shell completions can
optimize the build if there's an alternate API for the location that
doesn't involve using bash-completion.pc and fish.pc as build
dependencies. eg., Fedora provides the _tmpfilesdir RPM macro to
specify the location for vendor-supplied tmpfiles.d(5) files, which
makes it possible to avoid having systemd as a build dependency [3].
Finally, when installing to a non-system-wide prefix while hacking on
Toolbox as a non-root user, the locations for the completions in the
shells' APIs might not be accessible. Being able to override the
locations prevents the installation from failing.
[1] Debian zsh commit bf0a44a8744469b5
https://salsa.debian.org/debian/zsh/-/commit/bf0a44a8744469b5
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=620452
[2] https://src.fedoraproject.org/rpms/zsh/blob/f37/f/zsh.spec
[3] Fedora toolbox commit 9bebde5bb60f36e3
https://src.fedoraproject.org/rpms/toolbox/c/9bebde5bb60f36e3
containers#1123
containers#840
debarshiray
force-pushed
the
wip/rishi/remove-install_completions
branch
from
a3f93ea to
459acab
Compare
debarshiray
changed the title
debarshiray
changed the title
|
Build succeeded. ✔️ unit-test SUCCESS in 7m 16s |
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Sep 12, 2022
Names like bash_comp_dir and fish_comp_dir get missed when grepping for 'completion'. Note that the name of the directory is a plural, because it contains lots of completions for many different programs, just like the name of the pkgconfig variable. containers#1123
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Sep 12, 2022
Fallout from bafbbe8 containers#1123
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Sep 12, 2022
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Sep 12, 2022
The bash-completion and fish dependencies are already optional, and there's no dependency required for Z shell. The shell completions for Bash and fish won't be generated and installed if they are absent. So the build option isn't reducing the dependency burden. The build option is a way to disable the generation and installation of the shell completions, regardless of whether the necessary dependencies are present or not. The only use-case for this is when installing to a non-system-wide prefix while hacking on Toolbox as a non-root user, because the locations for the completions in the shells' APIs might not be accessible. Being able to disable the completions prevents the installation from failing. Fallout from bafbbe8 containers#1123 containers#840 build: Add options to override the locations for the shell completions This is particularly relevant for Z shell, because, unlike Bash's bash-completion.pc and fish's fish.pc, it doesn't have an API to detect the location for the shell completions and Debian and Fedora use different locations [1, 2]. Namely, /usr/share/zsh/vendor-completions and /usr/share/zsh/site-functions. An option to specify the locations for the shell completions can optimize the build if there's an alternate API for the location that doesn't involve using bash-completion.pc and fish.pc as build dependencies. eg., Fedora provides the _tmpfilesdir RPM macro to specify the location for vendor-supplied tmpfiles.d(5) files, which makes it possible to avoid having systemd as a build dependency [3]. Finally, when installing to a non-system-wide prefix while hacking on Toolbox as a non-root user, the locations for the completions in the shells' APIs might not be accessible. Being able to override the locations prevents the installation from failing. [1] Debian zsh commit bf0a44a8744469b5 https://salsa.debian.org/debian/zsh/-/commit/bf0a44a8744469b5 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=620452 [2] https://src.fedoraproject.org/rpms/zsh/blob/f37/f/zsh.spec [3] Fedora toolbox commit 9bebde5bb60f36e3 https://src.fedoraproject.org/rpms/toolbox/c/9bebde5bb60f36e3 containers#1123 containers#840
debarshiray
force-pushed
the
wip/rishi/remove-install_completions
branch
from
459acab to
837bea4
Compare
|
The code here is ready, but I still need to clean-up the commit message for the main commit and ensure that each commit builds and passes the tests. |
|
Build succeeded. ✔️ unit-test SUCCESS in 7m 40s |
HarryMichal
reviewed
Sep 16, 2022
HarryMichal
reviewed
Sep 16, 2022
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Oct 17, 2022
Names like bash_comp_dir and fish_comp_dir get missed when grepping for 'completion'. Note that the name of the directory is a plural, because it contains lots of completions for many different programs, just like the name of the pkgconfig variable. containers#1123
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Oct 17, 2022
Fallout from bafbbe8 containers#1123
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Oct 17, 2022
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Oct 17, 2022
Names like bash_comp_dir and fish_comp_dir get missed when grepping for 'completion'. Note that the name of the directory is a plural, because it contains lots of completions for many different programs, just like the name of the pkgconfig variable. containers#1123 containers#1138
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Oct 17, 2022
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Oct 17, 2022
debarshiray
changed the title
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Oct 21, 2022
The bash-completion and fish dependencies were already optional - the shell completions for Bash and fish won't be generated and installed if they are absent; and there's no dependency required for Z shell. So the install_completions build option wasn't reducing the dependency burden. The build option was a way to disable the generation and installation of the shell completions, regardless of whether the necessary dependencies are present or not. The only use-case for this is when installing to a non-system-wide prefix while hacking on Toolbox as a non-root user, because the locations for the completions advertised by the shells' APIs might not be accessible. Being able to disable the completions prevents the installation from failing. A different way of ensuring a smooth developer experience for a Toolbx hacker is to offer a way to change the locations where the shell completions are installed, which is necessary and beneficial for other use-cases. Z shell, unlike Bash's bash-completion.pc and fish's fish.pc, doesn't offer an API to detect the location for the shell completions. This means that Debian and Fedora use different locations [1, 2]. Namely, /usr/share/zsh/vendor-completions and /usr/share/zsh/site-functions. An option to specify the locations for the shell completions can optimize the build, if there's an alternate API for the location that doesn't involve using bash-completion.pc and fish.pc as build dependencies. eg., Fedora provides the _tmpfilesdir RPM macro to specify the location for vendor-supplied tmpfiles.d(5) files, which makes it possible to avoid having systemd.pc as a build dependency [3]. Fallout from bafbbe8 [1] Debian zsh commit bf0a44a8744469b5 https://salsa.debian.org/debian/zsh/-/commit/bf0a44a8744469b5 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=620452 [2] https://src.fedoraproject.org/rpms/zsh/blob/f37/f/zsh.spec [3] Fedora toolbox commit 9bebde5bb60f36e3 https://src.fedoraproject.org/rpms/toolbox/c/9bebde5bb60f36e3 containers#1123 containers#840
debarshiray
force-pushed
the
wip/rishi/remove-install_completions
branch
from
837bea4 to
5b0a54d
Compare
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Oct 21, 2022
The bash-completion and fish dependencies were already optional - the shell completions for Bash and fish won't be generated and installed if they are absent; and there's no dependency required for Z shell. So the install_completions build option wasn't reducing the dependency burden. The build option was a way to disable the generation and installation of the shell completions, regardless of whether the necessary dependencies are present or not. The only use-case for this is when installing to a non-system-wide prefix while hacking on Toolbox as a non-root user, because the locations for the completions advertised by the shells' APIs might not be accessible. Being able to disable the completions prevents the installation from failing. A different way of ensuring a smooth developer experience for a Toolbx hacker is to offer a way to change the locations where the shell completions are installed, which is necessary and beneficial for other use-cases. Z shell, unlike Bash's bash-completion.pc and fish's fish.pc, doesn't offer an API to detect the location for the shell completions. This means that Debian and Fedora use different locations [1, 2]. Namely, /usr/share/zsh/vendor-completions and /usr/share/zsh/site-functions. An option to specify the locations for the shell completions can optimize the build, if there's an alternate API for the location that doesn't involve using bash-completion.pc and fish.pc as build dependencies. eg., Fedora provides the _tmpfilesdir RPM macro to specify the location for vendor-supplied tmpfiles.d(5) files, which makes it possible to avoid having systemd.pc as a build dependency [3]. Fallout from bafbbe8 [1] Debian zsh commit bf0a44a8744469b5 https://salsa.debian.org/debian/zsh/-/commit/bf0a44a8744469b5 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=620452 [2] https://src.fedoraproject.org/rpms/zsh/blob/f37/f/zsh.spec [3] Fedora toolbox commit 9bebde5bb60f36e3 https://src.fedoraproject.org/rpms/toolbox/c/9bebde5bb60f36e3 containers#1123 containers#840
debarshiray
force-pushed
the
wip/rishi/remove-install_completions
branch
from
5b0a54d to
bcb2954
Compare
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Oct 21, 2022
debarshiray
added a commit
to debarshiray/toolbox
that referenced
this pull request
Oct 21, 2022
The bash-completion and fish dependencies were already optional - the shell completions for Bash and fish won't be generated and installed if they are absent; and there's no dependency required for Z shell. So the install_completions build option wasn't reducing the dependency burden. The build option was a way to disable the generation and installation of the shell completions, regardless of whether the necessary dependencies are present or not. The only use-case for this is when installing to a non-system-wide prefix while hacking on Toolbox as a non-root user, because the locations for the completions advertised by the shells' APIs might not be accessible. Being able to disable the completions prevents the installation from failing. A different way of ensuring a smooth developer experience for a Toolbx hacker is to offer a way to change the locations where the shell completions are installed, which is necessary and beneficial for other use-cases. Z shell, unlike Bash's bash-completion.pc and fish's fish.pc, doesn't offer an API to detect the location for the shell completions. This means that Debian and Fedora use different locations [1, 2]. Namely, /usr/share/zsh/vendor-completions and /usr/share/zsh/site-functions. An option to specify the locations for the shell completions can optimize the build, if there's an alternate API for the location that doesn't involve using bash-completion.pc and fish.pc as build dependencies. eg., Fedora provides the _tmpfilesdir RPM macro to specify the location for vendor-supplied tmpfiles.d(5) files, which makes it possible to avoid having systemd.pc as a build dependency [3]. Fallout from bafbbe8 [1] Debian zsh commit bf0a44a8744469b5 https://salsa.debian.org/debian/zsh/-/commit/bf0a44a8744469b5 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=620452 [2] https://src.fedoraproject.org/rpms/zsh/blob/f37/f/zsh.spec [3] Fedora toolbox commit 9bebde5bb60f36e3 https://src.fedoraproject.org/rpms/toolbox/c/9bebde5bb60f36e3 containers#1123 containers#840
debarshiray
force-pushed
the
wip/rishi/remove-install_completions
branch
from
bcb2954 to
f4dd862
Compare
|
Build succeeded. ✔️ unit-test SUCCESS in 7m 15s |
The bash-completion and fish dependencies were already optional - the shell completions for Bash and fish won't be generated and installed if they are absent; and there's no dependency required for Z shell. So the install_completions build option wasn't reducing the dependency burden. The build option was a way to disable the generation and installation of the shell completions, regardless of whether the necessary dependencies are present or not. The only use-case for this is when installing to a non-system-wide prefix while hacking on Toolbox as a non-root user, because the locations for the completions advertised by the shells' APIs might not be accessible. Being able to disable the completions prevents the installation from failing. A different way of ensuring a smooth developer experience for a Toolbx hacker is to offer a way to change the locations where the shell completions are installed, which is necessary and beneficial for other use-cases. Z shell, unlike Bash's bash-completion.pc and fish's fish.pc, doesn't offer an API to detect the location for the shell completions. This means that Debian and Fedora use different locations [1, 2]. Namely, /usr/share/zsh/vendor-completions and /usr/share/zsh/site-functions. An option to specify the locations for the shell completions can optimize the build, if there's an alternate API for the location that doesn't involve using bash-completion.pc and fish.pc as build dependencies. eg., Fedora provides the _tmpfilesdir RPM macro to specify the location for vendor-supplied tmpfiles.d(5) files, which makes it possible to avoid having systemd.pc as a build dependency [3]. Fallout from bafbbe8 [1] Debian zsh commit bf0a44a8744469b5 https://salsa.debian.org/debian/zsh/-/commit/bf0a44a8744469b5 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=620452 [2] https://src.fedoraproject.org/rpms/zsh/blob/f37/f/zsh.spec [3] Fedora toolbox commit 9bebde5bb60f36e3 https://src.fedoraproject.org/rpms/toolbox/c/9bebde5bb60f36e3 containers#1123 containers#840
debarshiray
force-pushed
the
wip/rishi/remove-install_completions
branch
from
f4dd862 to
5d26b9d
Compare
|
Build succeeded. ✔️ unit-test SUCCESS in 7m 18s |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
bash-completionandfishdependencies were already optional - the shell completions for Bash and fish won't be generated and installed if they are absent; and there's no dependency required for Z shell. So theinstall_completionsbuild option wasn't reducing the dependency burden.The build option was a way to disable the generation and installation of the shell completions, regardless of whether the necessary dependencies are present or not. The only use-case for this is when installing to a non-system-wide prefix while hacking on Toolbox as a non-root user, because the locations for the completions advertised by the shells' APIs might not be accessible. Being able to disable the completions prevents the installation from failing.
A different way of ensuring a smooth developer experience for a Toolbx hacker is to offer a way to change the locations where the shell completions are installed, which is necessary and beneficial for other use-cases.
Z shell, unlike Bash's
bash-completion.pcand fish'sfish.pc, doesn't offer an API to detect the location for the shell completions. This means that Debian and Fedora use different locations [1, 2]. Namely,/usr/share/zsh/vendor-completionsand/usr/share/zsh/site-functions.An option to specify the locations for the shell completions can optimize the build, if there's an alternate API for the location that
doesn't involve using
bash-completion.pcandfish.pcas build dependencies. eg., Fedora provides the_tmpfilesdirRPM macro to specify the location for vendor-suppliedtmpfiles.d(5)files, which makes it possible to avoid havingsystemd.pcas a build dependency [3].Fallout from bafbbe8
[1] Debian zsh commit bf0a44a8744469b5
https://salsa.debian.org/debian/zsh/-/commit/bf0a44a8744469b5
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=620452
[2] https://src.fedoraproject.org/rpms/zsh/blob/f37/f/zsh.spec
[3] Fedora toolbox commit 9bebde5bb60f36e3
https://src.fedoraproject.org/rpms/toolbox/c/9bebde5bb60f36e3
#840