Skip to content

installShellFiles: Allow installManPage to take a piped input #428382

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
Merged
merged 2 commits into from
Aug 22, 2025
Merged

installShellFiles: Allow installManPage to take a piped input #428382

merged 2 commits into from
Aug 22, 2025

Conversation

RossSmyth
Copy link
Contributor

Things done

  1. Add the --name flag to installManPage

This change is backwards compatible because the script would fail if you provided a file named --name previously. It now doesn't fail if for some reason that is desired.

  1. Install manpage from a pipe if a pipe is detected
  2. Add -- argument to stop parsing flags after
  3. Add tests
  4. Update documentation
  5. Add release notes
  • Built on platform:
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • Tested, as applicable:
  • Ran nixpkgs-review on this PR. See nixpkgs-review usage.
  • Tested basic functionality of all binary files, usually in ./result/bin/.
  • Nixpkgs Release Notes
    • Package update: when the change is major or breaking.
  • NixOS Release Notes
    • Module addition: when adding a new NixOS module.
    • Module update: when the change is significant.
  • Fits CONTRIBUTING.md, pkgs/README.md, maintainers/README.md and other READMEs.

Add a 👍 reaction to pull requests you find important.

@nix-owners nix-owners bot requested a review from Ericson2314 July 25, 2025 16:24
@nixpkgs-ci nixpkgs-ci bot added 10.rebuild-linux: 501+ This PR causes many rebuilds on Linux and should normally target the staging branches. 10.rebuild-darwin: 501+ This PR causes many rebuilds on Darwin and should normally target the staging branches. 10.rebuild-darwin-stdenv This PR causes stdenv to rebuild on Darwin and must target a staging branch. 10.rebuild-darwin: 5001+ This PR causes many rebuilds on Darwin and must target the staging branches. 10.rebuild-linux: 5001+ This PR causes many rebuilds on Linux and must target the staging branches. 8.has: changelog This PR adds or changes release notes 8.has: documentation This PR adds or changes documentation labels Jul 25, 2025
Ericson2314
Ericson2314 reviewed Aug 12, 2025
View reviewed changes
Ericson2314
Ericson2314 reviewed Aug 12, 2025
View reviewed changes
Ericson2314
Ericson2314 reviewed Aug 12, 2025
View reviewed changes
@RossSmyth RossSmyth requested a review from Ericson2314 August 13, 2025 01:57
Ericson2314
Ericson2314 approved these changes Aug 13, 2025
View reviewed changes
Copy link
Member

@Ericson2314 Ericson2314 left a comment

Choose a reason for hiding this comment

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

Though I think it would be good to leave open a bit before merging, in case someone else is strongly thinks the complexity of supporting pipes is not worth it

(I am curious what you want to use it for too)

@nixpkgs-ci nixpkgs-ci bot added the 12.approvals: 1 This PR was reviewed and approved by one person. label Aug 13, 2025
@RossSmyth
Copy link
Contributor Author

RossSmyth commented Aug 13, 2025 •
edited
Loading

I've come across some programs that output the manpages via stdin, so this is just a QOL thing, and brings it in line with the completion installer.

Can see some with rg '>.*\.1$'

@Ericson2314
Copy link
Member

OK, yeah the grep convinces me. Also it "clicked" that since no one wants to write Troff, and there are lots of powerful in-code CLI frameworks these days, programs that programmatically generate their own man pages are becoming more common.

@Ericson2314 Ericson2314 merged commit a53b472 into NixOS:staging Aug 22, 2025
28 of 29 checks passed
@RossSmyth RossSmyth deleted the manPipe branch August 22, 2025 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Ericson2314 Ericson2314 Ericson2314 approved these changes

Assignees
No one assigned
Labels
8.has: changelog This PR adds or changes release notes 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 501+ This PR causes many rebuilds on Darwin and should normally target the staging branches. 10.rebuild-darwin: 5001+ This PR causes many rebuilds on Darwin and must target the staging branches. 10.rebuild-darwin-stdenv This PR causes stdenv to rebuild on Darwin and must target a staging branch. 10.rebuild-linux: 501+ This PR causes many rebuilds on Linux and should normally target the staging branches. 10.rebuild-linux: 5001+ This PR causes many rebuilds on Linux and must target the staging branches. 12.approvals: 1 This PR was reviewed and approved by one person.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@RossSmyth @Ericson2314