Skip to content

ubootTools: add man pages#218561

Merged
doronbehar merged 1 commit intoNixOS:stagingfrom
lf-:jade/ubootTools-man
Aug 23, 2023
Merged

ubootTools: add man pages#218561
doronbehar merged 1 commit intoNixOS:stagingfrom
lf-:jade/ubootTools-man

Conversation

@lf-
Copy link
Copy Markdown
Member

@lf- lf- commented Feb 27, 2023 •
edited
Loading

Description of changes

As far as I can tell, there are no makefile targets to install these, or anything like that, so we have to do it by hand.

This adds man pages for dumpimage, kwboot, mkeficapsule, and mkimage. There are no man pages in other sections than 1.

Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • 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/)
  • 23.05 Release Notes (or backporting 22.11 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.

@lf-
Copy link
Copy Markdown
Member Author

lf- commented Feb 27, 2023

courtesy ping of maintainers: @bartsch @dezgeg @samueldr @lopsided98

@ofborg ofborg bot requested review from dezgeg, lopsided98 and samueldr February 27, 2023 05:42
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Feb 27, 2023
@samueldr
Copy link
Copy Markdown
Member

samueldr commented Feb 27, 2023

Looks fine in principle, haven't built yet, but assuming it does and manpages indeed are placed at the right place it should be fine.

@edef1c
Copy link
Copy Markdown
Member

edef1c commented Apr 21, 2023

Might be worth sticking this in a man output, rather than in $out.

@lf- lf- force-pushed the jade/ubootTools-man branch from bdfe1f3 to 077056a Compare April 22, 2023 07:20
@lf-
Copy link
Copy Markdown
Member Author

lf- commented Apr 22, 2023

Changed to provide a man output.

This is the output it produces:

» tree result-man
result-man
└── share
    └── man
        └── man1
            ├── dumpimage.1.gz
            ├── kwboot.1.gz
            ├── mkeficapsule.1.gz
            └── mkimage.1.gz

4 directories, 4 files

doronbehar
doronbehar reviewed Jul 30, 2023
View reviewed changes
@lf-
ubootTools: add man pages
614b639 
As far as I can tell, there are no makefile targets to install these, or
anything like that, so we have to do it by hand.

This adds man pages for dumpimage, kwboot, mkeficapsule, and mkimage.
There are no man pages in other sections than 1.
@lf- lf- force-pushed the jade/ubootTools-man branch from 077056a to 614b639 Compare July 30, 2023 21:29
@lf- lf- requested a review from doronbehar July 30, 2023 21:30
@ofborg ofborg bot added 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-darwin: 1 This PR causes 1 package to rebuild on Darwin. 10.rebuild-linux: 501+ This PR causes many rebuilds on Linux and should normally target the staging branches. 10.rebuild-linux: 2501-5000 This PR causes many rebuilds on Linux and should target the staging branches. and removed 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Jul 30, 2023
@doronbehar
Copy link
Copy Markdown
Contributor

doronbehar commented Jul 31, 2023

This should target staging, per the number of Linux rebuilds. Other then that I tested some rebuilds and it seems good and I tested the output structure and it seems good.

@lf-
Copy link
Copy Markdown
Member Author

lf- commented Aug 2, 2023

This should target staging, per the number of Linux rebuilds. Other then that I tested some rebuilds and it seems good and I tested the output structure and it seems good.

Oh, that's because of the addition to the buildUBoot thing. I didn't have that originally, but needed to add it to get the man page installation function. Annoying; I wish that we had ca-derivations. Will change the branch.

@lf- lf- changed the base branch from master to staging August 2, 2023 03:32
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. and removed 10.rebuild-darwin: 1 This PR causes 1 package to rebuild on Darwin. 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-linux: 501+ This PR causes many rebuilds on Linux and should normally target the staging branches. 10.rebuild-linux: 2501-5000 This PR causes many rebuilds on Linux and should target the staging branches. labels Aug 2, 2023
@lf-
Copy link
Copy Markdown
Member Author

lf- commented Aug 23, 2023

@doronbehar I fixed the branch, should be good to merge I think?

@doronbehar
Copy link
Copy Markdown
Contributor

doronbehar commented Aug 23, 2023

@doronbehar I fixed the branch, should be good to merge I think?

Yes it is! I didn't got notified you did switch the target branch...

@doronbehar doronbehar merged commit c121c5f into NixOS:staging Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@samueldr samueldr Awaiting requested review from samueldr

@dezgeg dezgeg Awaiting requested review from dezgeg

@lopsided98 lopsided98 Awaiting requested review from lopsided98

@doronbehar doronbehar Awaiting requested review from doronbehar

Assignees

No one assigned

Labels

10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@lf- @samueldr @edef1c @doronbehar