Skip to content

doc: warn against zero-byte or missing shell completion files#325591

Merged
LeSuisse merged 1 commit intoNixOS:masterfrom
SFrijters:install-shell-completion-doc
Jul 12, 2024
Merged

doc: warn against zero-byte or missing shell completion files#325591
LeSuisse merged 1 commit intoNixOS:masterfrom
SFrijters:install-shell-completion-doc

Conversation

@SFrijters
Copy link
Member

Description of changes

Clarify common failure mode of #289517 .

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.11 Release Notes (or backporting 23.11 and 24.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@SFrijters SFrijters requested a review from LeSuisse July 8, 2024 17:16
@github-actions github-actions bot added the 8.has: documentation This PR adds or changes documentation label Jul 8, 2024
Copy link
Member

Choose a reason for hiding this comment

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

L20 to 24 should probably be removed in favor of the next paragraph?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, makes sense. Removed the duplicated code and moved the line about fifo/named fd closer to its actual example.

@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux. labels Jul 8, 2024
@LeSuisse LeSuisse merged commit 2d419e7 into NixOS:master Jul 12, 2024
@SFrijters SFrijters deleted the install-shell-completion-doc branch July 13, 2024 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants