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.

Sign up for GitHub

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

Jump to bottom

nixos/make-options-doc: add option enableDiscardBuiltinOptions #293494

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

nixos/make-options-doc: add option enableDiscardBuiltinOptions #293494

wants to merge 1 commit into from

Conversation

frederictobiasc
Copy link
Contributor

Description of changes

This option allows disabling the generation of documentation for built-in module system options like _module.args.

Those are generated since b9756b4

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • 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/)
  • 24.05 Release Notes (or backporting 23.05 and 23.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
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added the 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS label Mar 5, 2024
@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 Mar 5, 2024
@frederictobiasc frederictobiasc mentioned this pull request Mar 5, 2024
Open
@frederictobiasc
Copy link
Contributor Author

cc @ryantm @asymmetric @hsjobeki

@frederictobiasc frederictobiasc force-pushed the enableDiscardBuiltinOptions branch 3 times, most recently from 6abecb7 to a78a14d Compare March 5, 2024 14:05
@hsjobeki
Copy link
Contributor

hsjobeki commented Mar 5, 2024 •
edited
Loading

How about calling this flag discardInternalOptions or includeInternalOptions ? true.

@frederictobiasc
nixos/make-options-doc: add option enableDiscardBuiltinOptions
324a535 
This option allows disabling the generation of documentation for
built-in module system options like `_module.args`.

Those are generated since NixOS@b9756b4
@frederictobiasc frederictobiasc force-pushed the enableDiscardBuiltinOptions branch from 0b32425 to 324a535 Compare March 5, 2024 15:15
@frederictobiasc
Copy link
Contributor Author

Thanks for your review!

How about calling this flag discardInternalOptions or includeInternalOptions ? true.

That sounds much better.

@ofborg ofborg bot added the 2.status: merge conflict This PR has merge conflicts with the target branch label Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hsjobeki hsjobeki hsjobeki left review comments

Assignees
No one assigned
Labels
2.status: merge conflict This PR has merge conflicts with the target branch 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@frederictobiasc @hsjobeki