about summary refs log tree commit diff
path: root/nixos/doc/manual/release-notes
diff options
context:
space:
mode:
authorMaximilian Bosch <maximilian@mbosch.me>2018-04-26 10:31:05 +0200
committerMaximilian Bosch <maximilian@mbosch.me>2018-04-28 14:23:53 +0200
commit9274ea390348e17f766732e7fbd335e3bc164954 (patch)
treeea75418843caff7129e5b9b87434e59f9cac0ef1 /nixos/doc/manual/release-notes
parent39909289f452fcd60127cbd2372f22ac35f25d08 (diff)
downloadnixlib-9274ea390348e17f766732e7fbd335e3bc164954.tar
nixlib-9274ea390348e17f766732e7fbd335e3bc164954.tar.gz
nixlib-9274ea390348e17f766732e7fbd335e3bc164954.tar.bz2
nixlib-9274ea390348e17f766732e7fbd335e3bc164954.tar.lz
nixlib-9274ea390348e17f766732e7fbd335e3bc164954.tar.xz
nixlib-9274ea390348e17f766732e7fbd335e3bc164954.tar.zst
nixlib-9274ea390348e17f766732e7fbd335e3bc164954.zip
treewide: rename version attributes
As suggested in https://github.com/NixOS/nixpkgs/pull/39416#discussion_r183845745
the versioning attributes in `lib` should be consistent to
`nixos/version` which implicates the following changes:

* `lib.trivial.version` -> `lib.trivial.release`
* `lib.trivial.suffix` -> `lib.trivial.versionSuffix`
* `lib.nixpkgsVersion` -> `lib.version`

As `lib.nixpkgsVersion` is referenced several times in `NixOS/nixpkgs`,
`NixOS/nix` and probably several user's setups. As the rename will cause
a notable impact it's better to keep `lib.nixpkgsVersion` as alias with
a warning yielded by `builtins.trace`.
Diffstat (limited to 'nixos/doc/manual/release-notes')
-rw-r--r--nixos/doc/manual/release-notes/rl-1809.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/nixos/doc/manual/release-notes/rl-1809.xml b/nixos/doc/manual/release-notes/rl-1809.xml
index 2e53f0563baf..949dbf0e0c1e 100644
--- a/nixos/doc/manual/release-notes/rl-1809.xml
+++ b/nixos/doc/manual/release-notes/rl-1809.xml
@@ -123,6 +123,11 @@ following incompatible changes:</para>
       <literal>lib.traceCallXml</literal> has been deprecated. Please complain
       if you use the function regularly.
     </para>
+    <para>
+      The attribute <literal>lib.nixpkgsVersion</literal> has been deprecated in favor of
+      <literal>lib.version</literal>. Please refer to the discussion in
+      <link xlink:href="https://github.com/NixOS/nixpkgs/pull/39416#discussion_r183845745">NixOS/nixpkgs#39416</link> for further reference.
+    </para>
   </listitem>
 </itemizedlist>