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

Fix man pages in i3-gaps #86294

Merged
merged 2 commits into from May 7, 2020

Conversation

DamienCassou
Copy link
Contributor

Motivation for this change

The files with the .man extension are asciidoc versions of the man
pages and should not be copied to share/man or mandb complains:

mandb: warning: …/man/man1/i3.man.gz: ignoring bogus filename

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

/cc maintainers of i3: @modulistic @fpletz @globin
/cc maintainers of i3-gaps @fmthoma

@DamienCassou
Copy link
Contributor Author

I removed one commit because @r-ryantm updated i3-gaps to 4.18.1 in the meantime.

Copy link
Member

@cole-h cole-h left a comment

Choose a reason for hiding this comment

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

Diff LGTM. In the nixpkgs-review shell, ls results/i3-gaps/share/man/man1 shows all files are *.1.gz, whereas before this fix, they are *.man.gz.

https://github.com/NixOS/nixpkgs/pull/86294
10 packages built:
i3 i3-gaps i3-layout-manager i3-wk-switch polybarFull python37Packages.i3ipc python37Packages.py3sta
tus python38Packages.i3ipc python38Packages.py3status raiseorlaunch

@DamienCassou DamienCassou force-pushed the damien/fix-i3-manpages branch 2 times, most recently from 2626b49 to 97f55eb Compare May 7, 2020 18:28
The files with the .man extension are asciidoc versions of the man
pages and should not be copied to share/man or mandb complains:

mandb: warning: …/man/man1/i3.man.gz: ignoring bogus filename
The .tar.gz from the github's archive does not contain man pages, only
asciidoc versions of them. Because i3-gaps uses the same build process
as i3, the man pages are not generated and the asciidoc versions are
put in share/man/man1. This annoys mandb:

mandb: warning: …/share/man/man1/i3.man.gz: ignoring bogus filename

This commit changes the downloaded file to use github's release
instead. The resulting .tar.bz2 file is much closer to the one
downloaded for i3 which means the build process can still be the same
and we get proper man pages at the end.

Because of the previous change, the I3_VERSION file is now part of the
downloaded source which means Nix doesn't have to create it anymore.
@DamienCassou
Copy link
Contributor Author

Result of nixpkgs-review pr 86294 1

10 packages built:
- i3
- i3-gaps
- i3-layout-manager
- i3-wk-switch
- polybarFull
- python37Packages.i3ipc
- python37Packages.py3status
- python38Packages.i3ipc
- python38Packages.py3status
- raiseorlaunch

@DamienCassou DamienCassou requested a review from cole-h May 7, 2020 18:56
@DamienCassou
Copy link
Contributor Author

@cole-h I changed my PR so it uses installManPage as you requested.

Copy link
Member

@cole-h cole-h left a comment

Choose a reason for hiding this comment

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

Diff LGTM. Thanks!

[12 built, 151 copied (587.8 MiB), 148.4 MiB DL]
https://github.com/NixOS/nixpkgs/pull/86294
10 packages built:
i3 i3-gaps i3-layout-manager i3-wk-switch polybarFull python37Packages.i3ipc python37Packages.py3status python38Packages.i3ipc python38Packages.py3status raiseorlaunch

@DamienCassou DamienCassou merged commit 58ba831 into NixOS:master May 7, 2020
@DamienCassou DamienCassou deleted the damien/fix-i3-manpages branch May 7, 2020 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants