Merge #222867: aliases: document avoiding them within nixpkgs better

This commit is contained in:
Vladimír Čunát 2023-04-02 08:28:24 +02:00
commit e77e6a9e40
No known key found for this signature in database
GPG key ID: E747DF1F9575A3AA

View file

@ -1,5 +1,22 @@
lib: self: super:
### Deprecated aliases - for backward compatibility
### Please maintain this list in ASCIIbetical ordering.
### Hint: the "sections" are delimited by ### <letter> ###
# These aliases should not be used within nixpkgs, but exist to improve
# backward compatibility in projects outside of nixpkgs. See the
# documentation for the `allowAliases` option for more background.
# A script to convert old aliases to throws and remove old
# throws can be found in './maintainers/scripts/remove-old-aliases.py'.
# Add 'preserve, reason: reason why' after the date if the alias should not be removed.
# Try to keep them to a minimum.
# valid examples of what to preserve:
# distro aliases such as:
# debian-package-name -> nixos-package-name
with self;
let
@ -31,19 +48,6 @@ let
aliases;
in
### Deprecated aliases - for backward compatibility
### Please maintain this list in ASCIIbetical ordering.
### Hint: the "sections" are delimited by ### <letter> ###
# A script to convert old aliases to throws and remove old
# throws can be found in './maintainers/scripts/remove-old-aliases.py'.
# Add 'preserve, reason: reason why' after the date if the alias should not be removed.
# Try to keep them to a minimum.
# valid examples of what to preserve:
# distro aliases such as:
# debian-package-name -> nixos-package-name
mapAliases ({
# Added 2018-07-16 preserve, reason: forceSystem should not be used directly in Nixpkgs.
forceSystem = system: _: