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.

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

Manual: make reproducible #55375

Merged
merged 1 commit into from Feb 7, 2019
Merged

Manual: make reproducible #55375

merged 1 commit into from Feb 7, 2019

Conversation

grahamc
Copy link
Member

@grahamc grahamc commented Feb 7, 2019

Motivation for this change

https://r13y.com/diff/18l0mncd1jaqkqdjd64h0099b4757v31-nixos-manual-html.drv.html

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • 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 nox --run "nox-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)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@samueldr
Copy link
Member

samueldr commented Feb 7, 2019

We may want to fail the manual build on missing IDs if this is what is required to make it reproducible, right?

@grahamc
Copy link
Member Author

grahamc commented Feb 7, 2019

Yes, I think so. I wonder if docbook has a nice option to force that.

@grahamc grahamc merged commit 06c93d8 into NixOS:master Feb 7, 2019
@grahamc grahamc deleted the manual branch February 7, 2019 03:50
@layus layus mentioned this pull request Feb 7, 2019
Merged
2 tasks
@layus
Copy link
Member

layus commented Feb 7, 2019 •
edited

I found that docbook has an id.warnings property[1] that indeed detects such cases.

The option emits warnings that could be turned into errors with grep if nothing else works.
There is still a strange issue with ID recommended on partintro wich happens four times, one for each manual part. As per the above doc, partintro contains no title and this report could be a bug.

$ nix-build nixos -A config.system.build.manual.manualHTML --check
checking outputs of '/nix/store/gg6801znhniwlznbfcdlm8wcrwj9qdcj-nixos-manual-html.drv'...
ID recommended on partintro
ID recommended on partintro
ID recommended on section: Basic Usage
ID recommended on section: Re-attaching to WeeChat
ID recommended on partintro
ID recommended on partintro
Writing options.html for appendix(ch-options)
Writing release-notes.html for appendix(ch-release-notes)
Writing index.html for book(book-nixos-manual)

See #55396 for the proper diff.

This was referenced Feb 7, 2019
Open
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@infinisil infinisil Awaiting requested review from infinisil

Assignees
No one assigned
Labels
6.topic: nixos 8.has: module (update) 10.rebuild-darwin: 0 10.rebuild-linux: 1-10
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@grahamc @samueldr @layus @GrahamcOfBorg