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

Overhaul shell completion docs #3961

Merged
merged 1 commit into from
Feb 6, 2024
Merged

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Jan 19, 2024

Description

Fixes:

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 added the documentation Improvements or additions to documentation label Jan 19, 2024
@twz123 twz123 requested a review from a team as a code owner January 19, 2024 16:30
@twz123 twz123 linked an issue Jan 19, 2024 that may be closed by this pull request
mkdir ~/.bash_completion.d
k0s completion bash >~/.bash_completion.d/k0s

cat <<'EOF' >~/.bashrc
Copy link
Contributor

Choose a reason for hiding this comment

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

how about something like this?

grep -q .bash_completion.d .bashrc || cat <<'EOF'

Copy link
Member Author

Choose a reason for hiding this comment

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

I tried to find some references about the idiomatic way of including user-managed bash shell completions, but I didn't really find anything. The bash_completion.d stuff seems to be used, but there doesn't seem to be "the way of doing it". That's why I tried to give an example with the caveat "adjust to your personal needs". Checking if the folder has already been set up in .bashrc or some other place is not a piece of cake. That's why I opted for not doing it.

If you think checking would be better, then I'd probably change this to some descriptive block where to put the snippet, similar to the examples for zsh.

WDYT?

@twz123 twz123 merged commit babb2f6 into k0sproject:main Feb 6, 2024
8 checks passed
@twz123 twz123 deleted the shell-completion-docs branch February 6, 2024 16:26
@twz123 twz123 mentioned this pull request May 28, 2024
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation for Zsh autocompletion
3 participants