Skip to content

Comments

Fix manual Makefile by including function doc generation#55040

Merged
samueldr merged 1 commit intoNixOS:masterfrom
tazjin:docs/fix-manual-makefile
Feb 10, 2019
Merged

Fix manual Makefile by including function doc generation#55040
samueldr merged 1 commit intoNixOS:masterfrom
tazjin:docs/fix-manual-makefile

Conversation

@tazjin
Copy link
Member

@tazjin tazjin commented Feb 1, 2019

Since #53055 was merged the Makefile for the manual could not be run
correctly as the generated function documentation was included, but
not actually generated.

This adds the necessary generation step by first building the XML file
containing function locations and preserving its store path in a
variable, which is then used both for linking of the locations file
and as a build input for the function docs generator.

This fixes #55014

Side note: Recreating the derivation dependencies this way in the Makefile is a little bit awkward. Better suggestions welcome! 🤔


Motivation for this change

Manual builds were broken (as per #55014)

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.

Since NixOS#53055 was merged the Makefile for the manual could not be run
correctly as the generated function documentation was included, but
not actually generated.

This adds the necessary generation step by first building the XML file
containing function locations and preserving its store path in a
variable, which is then used both for linking of the locations file
and as a build input for the function docs generator.

This fixes NixOS#55014
@GrahamcOfBorg GrahamcOfBorg added 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. labels Feb 1, 2019
@matthewbauer matthewbauer requested a review from grahamc February 4, 2019 14:55
@samueldr
Copy link
Member

When reproducing the failure/success, be sure you make clean, as the file isn't re-generated without cleaning.

@samueldr samueldr merged commit 3172cc6 into NixOS:master Feb 10, 2019
@tazjin tazjin deleted the docs/fix-manual-makefile branch February 10, 2019 20:46
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.

Build of NixPkgs manual is broken

4 participants