Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

config.allowAliases: Define as option #166792

Merged
merged 1 commit into from
Apr 4, 2022

Conversation

roberth
Copy link
Member

@roberth roberth commented Apr 1, 2022

Motivation and description

This simplifies usages and makes the default value consistent.

In a few cases, the default value was interpreted to be false,
but this is useless, because virtually nobody will explicitly
set allowAliases = true;.

Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 22.05 Release Notes (or backporting 21.11 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
    • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
  • Fits CONTRIBUTING.md.

This simplifies usages and makes the default value consistent.

In a few cases, the default value was interpreted to be `false`,
but this is useless, because virtually nobody will explicitly
set `allowAliases = true;`.
@FRidh
Copy link
Member

FRidh commented Apr 4, 2022

I think we should do this for all config options used in nixpkgs. And then generate documentation out of it like we do with the nixos modules.

See also #56227 which takes it even further (though maybe a bit too far with use flags).

@roberth roberth merged commit a292213 into NixOS:master Apr 4, 2022
@zowoq
Copy link
Contributor

zowoq commented Apr 8, 2022

https://hydra.nixos.org/eval/1753299#tabs-removed

Seems this broke terraform-full?

roberth added a commit to hercules-ci/nixpkgs that referenced this pull request Apr 8, 2022
NixOS#166792 made the
aliases work, which was unexpected for terraform-full.

Thanks to zowoq for reporting
NixOS#166792 (comment)
@roberth roberth mentioned this pull request Apr 8, 2022
13 tasks
zimbatm pushed a commit that referenced this pull request Apr 9, 2022
#166792 made the
aliases work, which was unexpected for terraform-full.

Thanks to zowoq for reporting
#166792 (comment)
zhaofengli added a commit to zhaofengli/colmena that referenced this pull request Apr 25, 2022
@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/where-are-options-like-config-cudasupport-documented/17805/4

@rehno-lindeque rehno-lindeque mentioned this pull request Apr 29, 2022
13 tasks
@roberth
Copy link
Member Author

roberth commented May 2, 2022

generate documentation

#171163

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants