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

nixos/doc: documentation angle bracket syntax #63033

Open
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
1 participant
@tobiasBora
Copy link
Contributor

commented Jun 12, 2019

Motivation for this change

Lack of documentation for <...> syntax, and add link to https://nixos.org/nixos/options.html. The goal is to partially solve the 3 year old bug NixOS/nix#338.

Things done

I just modified nixos/doc/manual/configuration/customizing-packages.xml and nixos/doc/manual/configuration/summary.xml, and then I ran make in nixos/doc/manual, and nix-build nixos/release.nix -A manual.x86_64-linux at the source.

  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nix-review --run "nix-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.