lib/trivial: add manualRevision

ncfavier · ncfavier · commit e9fe624505cb · 2022-12-01T18:27:03.000+01:00
This variable is set to "master" on master and "release-YY.DD" on the
release branches so that the manual can link to the correct revision.
diff --git a/doc/default.nix b/doc/default.nix
@@ -1,7 +1,7 @@
-{ pkgs ? (import ./.. { }), nixpkgs ? { }}:
+{ pkgs ? import ./.. { } }:
 let
   lib = pkgs.lib;
-  doc-support = import ./doc-support { inherit pkgs nixpkgs; };
+  doc-support = import ./doc-support { inherit pkgs; };
 in pkgs.stdenv.mkDerivation {
   name = "nixpkgs-manual";
 
diff --git a/doc/doc-support/default.nix b/doc/doc-support/default.nix
@@ -1,9 +1,9 @@
-{ pkgs ? (import ../.. {}), nixpkgs ? { }}:
+{ pkgs ? import ../.. {} }:
 let
   inherit (pkgs) lib;
   inherit (lib) hasPrefix removePrefix;
 
-  locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs; };
+  locationsXml = import ./lib-function-locations.nix { inherit pkgs; };
   functionDocs = import ./lib-function-docs.nix { inherit locationsXml pkgs; };
   version = pkgs.lib.version;
 
diff --git a/doc/doc-support/lib-function-locations.nix b/doc/doc-support/lib-function-locations.nix
@@ -1,7 +1,5 @@
-{ pkgs ? (import ./.. { }), nixpkgs ? { }}:
+{ pkgs ? import ./.. { } }:
 let
-  revision = pkgs.lib.trivial.revisionWithDefault (nixpkgs.revision or "master");
-
   libDefPos = set:
     builtins.map
       (name: {
@@ -57,7 +55,7 @@ let
     [ "'"      ]
     [ "-prime" ];
 
-  urlPrefix = "https://github.com/NixOS/nixpkgs/blob/${revision}";
+  urlPrefix = "https://github.com/NixOS/nixpkgs/blob/${nixpkgsLib.trivial.manualRevision}";
   xmlstrings = (nixpkgsLib.strings.concatMapStrings
       ({ name, value }:
       ''
diff --git a/lib/trivial.nix b/lib/trivial.nix
@@ -222,6 +222,10 @@ rec {
 
   nixpkgsVersion = builtins.trace "`lib.nixpkgsVersion` is deprecated, use `lib.version` instead!" version;
 
+  /* The revision to which the manual should link.
+     Set this to "release-YY.MM" after branch-off. */
+  manualRevision = "master";
+
   /* Determine whether the function is being called from inside a Nix
      shell.
 
diff --git a/pkgs/top-level/release.nix b/pkgs/top-level/release.nix
@@ -35,7 +35,7 @@ let
 
       metrics = import ./metrics.nix { inherit pkgs nixpkgs; };
 
-      manual = import ../../doc { inherit pkgs nixpkgs; };
+      manual = import ../../doc { inherit pkgs; };
       lib-tests = import ../../lib/tests/release.nix { inherit pkgs; };
       pkgs-lib-tests = import ../pkgs-lib/tests { inherit pkgs; };
 
