Skip to content
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.

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

Documentation: rclone_genautocomplete_bash.md example command looks incorrect for SLES/openSUSE/Rocky? #7745

Open
pawsey-kbuckley opened this issue Apr 9, 2024 · 1 comment
Labels

Comments

@pawsey-kbuckley
Copy link
Contributor

The rclone_genautocomplete_bash.md file renders, within this GitHub repo, as

"Logout and login again to use the autocompletion scripts, or source them directly

. /etc/bash_completion

If you supply a command line argument ..."

however, if you are sourcing the script (singular) that that doc, a couple of lines
above, tell you gets created by default, directly, then should the example
not be telling you to do this

. /etc/bash_completion.d/rclone

instead?

I am thinking that the documentation's choice, of sourcing a utility
file /etc/bash_completion that, on Ubuntu, actually sources this

/usr/share/bash-completion/bash_completion

might cause some confusion, as it did, for me. on a couple of SLES,
openSUSE and Rocky 9 systems we run here, where

/etc/bash_completion

doesn't exist, even though the

/usr/share/bash-completion/bash_completion

file does.

If one does, as I did for testing without root/sudo, create a single
automcompletion script, then the sourcing of it would want the full
path to the script specified anyway.

Maybe then, the text and example should read, as follows, where the
script is singular:

"Logout and login again to use the autocompletion script, or source it directly

. /etc/bash_completion.d/rclone

If you supply a command line argument ..."

@ncw
Copy link
Member

ncw commented Apr 10, 2024

Thanks for spotting this.

The source code for the docs is here - this is the only place which needs changing.

https://github.com/rclone/rclone/blob/master/cmd/genautocomplete/genautocomplete_bash.go

Do you fancy editing it to make a correction? You can do it in the web browser by clicking the pencil icon on that page - it will then make an edit for us to review. (Or you could send a Pull Request if you know how and would prefer).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants