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

Jump to bottom

nixos/doc: documentation angle bracket syntax #63033

Closed
wants to merge 2 commits into from
Closed

nixos/doc: documentation angle bracket syntax #63033

wants to merge 2 commits into from

Conversation

tobiasBora
Copy link
Contributor

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.

@multun
Copy link
Member

multun commented Oct 18, 2019

LGTM,would you mind only committing related changes ?

@ersinakinci ersinakinci mentioned this pull request Oct 21, 2019
Closed
@stale
Copy link

stale bot commented Jun 1, 2020

Thank you for your contributions.
This has been automatically marked as stale because it has had no activity for 180 days.
If this is still important to you, we ask that you leave a comment below. Your comment can be as simple as "still important to me". This lets people see that at least one person still cares about this. Someone will have to do this at most twice a year if there is no other activity.
Here are suggestions that might help resolve this more quickly:

  1. Search for maintainers and people that previously touched the
    related code and @ mention them in a comment.
  2. Ask on the NixOS Discourse. 3. Ask on the #nixos channel on
    irc.freenode.net.

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 1, 2020
@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Aug 16, 2020
jtojnar
jtojnar requested changes Aug 16, 2020
View reviewed changes
Copy link
Contributor

@jtojnar jtojnar left a comment

Choose a reason for hiding this comment

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

Could you also drop the formatting changes in unrelated files so it is easier to review?

nixos/doc/manual/configuration/customizing-packages.xml
@@ -17,7 +17,10 @@
<warning>
<para>
Unfortunately, Nixpkgs currently lacks a way to query available
configuration options.
configuration options from command line. You can however go to
Copy link
Contributor

Choose a reason for hiding this comment

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

These are different options than the section is talking about.

You are describing NixOS module options but this is talking about package options (that is the attribute set you pass as config when creating nixpkgs, or through nixpkgs.config NixOS option. There still is not a way to query those as far as I am aware.

And for NixOS options, you can actually use man configuration.nix or nixos-option commands.

jtojnar
jtojnar reviewed Aug 16, 2020
View reviewed changes
nixos/doc/manual/configuration/summary.xml
@@ -215,6 +215,17 @@ xlink:href="http://nixos.org/nix/manual/#chap-writing-nix-expressions">Nix
</entry>
<entry>Apply a function to every element of a list (evaluates to <literal>[ 2 4 6 ]</literal>)</entry>
</row>
<row>
Copy link
Contributor

Choose a reason for hiding this comment

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

Also this should probably go to basic values group, not the builtin functions.

@stale
Copy link

stale bot commented Jun 4, 2021

I marked this as stale due to inactivity. → More info

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 4, 2021
@fricklerhandwerk
Copy link
Contributor

Closing as this is long out of sync with the Nixpkgs manual, and since the Nix manual now documents the syntax and gives it a proper name so we can talk about it: lookup path

@nixos-discourse
Copy link

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

https://discourse.nixos.org/t/wiki-nixos-org-is-now-live/42570/59

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jtojnar jtojnar jtojnar requested changes

Assignees
No one assigned
Labels
2.status: merge conflict 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 6.topic: nixos 8.has: changelog 8.has: documentation 8.has: module (update) 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@tobiasBora @multun @fricklerhandwerk @nixos-discourse @jtojnar @ryantm @alyssais