Unverified Commit 587f64a2 authored by Philip Taron's avatar Philip Taron
Browse files

nixpkgs-manual: use injected revision only 

`lib.trivial.revisionWithDefault` will change with every Git commit, which causes the manual to be rebuilt on every since PR.

Using `nixpkgs.rev` (or the dummy value "master" if it's not present) means that the manual will contain the revision if built on Hydra, but will not otherwise.

Why?

1. https://hydra.nixos.org/jobset/nixos/trunk-combined#tabs-configuration shows that `pkgs/top-level/release.nix` is passed the `nixpkgs` attrset, which is a "Git checkout".
2. Git checkouts come from [`builtins.fetchGit`](https://nix.dev/manual/nix/2.18/language/builtins#builtins-fetchGit) and include the `rev` attribute.
3. The `rev` attribute is what `lib.trivial.revisionWithDefault` would have returned.

So, using `nixpkgs.rev or "master"` exclusively will cause the rebuilds on every commit to cease, but will allow "official" nixpkgs manual built on Hydra to continue to reference a specific commit.
parent f4f322d1

doc/doc-support/package.nix

+1 −1
Original line number Diff line number Diff line
@@ -60,7 +60,7 @@ stdenvNoCC.mkDerivation ( 


      nixos-render-docs manual html \

        --manpage-urls ./manpage-urls.json \

        --revision ${lib.trivial.revisionWithDefault (nixpkgs.rev or "master")} \

        --revision ${nixpkgs.rev or "master"} \

        --stylesheet style.css \

        --stylesheet highlightjs/mono-blue.css \

        --script ./highlightjs/highlight.pack.js \