-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
Deprecated child options appear in manual when renaming submodule #82862
Copy link
Copy link
Closed
Labels
0.kind: bugSomething is brokenSomething is broken0.kind: regressionSomething that worked before working no longerSomething that worked before working no longer6.topic: module systemAbout "NixOS" module system internalsAbout "NixOS" module system internals6.topic: nixosIssues or PRs affecting NixOS modules, or package usability issues specific to NixOSIssues or PRs affecting NixOS modules, or package usability issues specific to NixOS
Metadata
Metadata
Assignees
Labels
0.kind: bugSomething is brokenSomething is broken0.kind: regressionSomething that worked before working no longerSomething that worked before working no longer6.topic: module systemAbout "NixOS" module system internalsAbout "NixOS" module system internals6.topic: nixosIssues or PRs affecting NixOS modules, or package usability issues specific to NixOSIssues or PRs affecting NixOS modules, or package usability issues specific to NixOS
Fields
Give feedbackNo fields configured for issues without a type.
Describe the bug
When renaming a submodule, the
mkRenamedOptionModulemakes the child options reappear in the docs at the old location.This did not happen before #78135 (ping @infinisil)
I've encountered the problem in the arion docs when upgrading its tooling to nixpkgs 20.03. The move is
docker-compose.services->services. The regression makes the docs start with a mountain of legacy options comprising just under half of all options.Reverting #78135 fixes the problem.
To Reproduce
Steps to reproduce the behavior:
legacy.services.<name>.enablelegacy.servicestoserviceslegacy.services.<name>.enableis in the docs, despitelegacy.services.visible = falseExpected behavior
The option docs should have at most one entry per renamed option. Any suboptions should be omitted.
Screenshots
If applicable, add screenshots to help explain your problem.
Additional context
Add any other context about the problem here.
Metadata
Please run
nix-shell -p nix-info --run "nix-info -m"and paste the result.Maintainer information: