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

lib.modules: Allow making _module.args internal #167776

Conversation

roberth
Copy link
Member

@roberth roberth commented Apr 7, 2022

Description of changes

Makes #165540 opt-out.

This allows other module system consumers to disable these docs using option merging.

For instance arion uses asciidoc instead of docbook so that would look awful.

Implementation note:

I figured a dynamic attr would perform better than an optionalAttrs call + extra attrset garbage.

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.

@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Apr 7, 2022
lib/modules.nix Outdated
internal = prefix != [];
# Allow other mkOption decls to make this internal regardless.
${if prefix == []
then null # unset; default is true
Copy link
Member

@infinisil infinisil Apr 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure the default is false? How does this even still get rendered with that?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, I must have been thinking of visibility instead of internalness. Now it's:

then null  # unset => visible

@roberth roberth force-pushed the lib-modules-allow-disable-_modules.args-docs-internal branch from 35f40b2 to 1e9b970 Compare April 11, 2022 09:17
This allows other module system consumers to
disable these docs via option merging.

For instance arion uses asciidoc instead of
docbook so that would look awful.
@roberth roberth force-pushed the lib-modules-allow-disable-_modules.args-docs-internal branch from 1e9b970 to 14aa201 Compare April 11, 2022 09:17
@roberth roberth requested a review from infinisil April 13, 2022 10:38
@roberth roberth merged commit c2451ed into NixOS:master Apr 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants