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

doc: nixos.configuration.abstractions: Explore #71120

Closed
wants to merge 1 commit into from
Closed

doc: nixos.configuration.abstractions: Explore #71120

wants to merge 1 commit into from

Conversation

SRGOM
Copy link
Member

@SRGOM SRGOM commented Oct 14, 2019

Explore nixos options using nix repl.
From: https://discourse.nixos.org/t/how-do-you-explore-a-nix-expression/4088/3

Motivation for this change
Things done
  • 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)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
Notify maintainers

cc @

@nixos-discourse
Copy link

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

https://discourse.nixos.org/t/how-do-you-explore-a-nix-expression/4088/8

@danbst
Copy link
Contributor

danbst commented Oct 16, 2019

There is a problem that examples use non-standard locations "/home/danbst/power-profile/profiles/base.nix" and so on. Those have to be replaced with more standard.

@SRGOM
Copy link
Member Author

SRGOM commented Oct 16, 2019

I left that as a nod to you but on second thoughts this is manual not wiki. Rest all good?

@danbst
Copy link
Contributor

danbst commented Oct 17, 2019

@SRGOM to be honest, I'm not sure. The whole point of using nix-shell here is to use autocomplete as a discoverability tool (a replacement of proper UI). If you want to query meta-information about an option, nixos-option is usually enough (it shows all of these).

And also, this discloses module system internals - the thing which was avoided in docs until now. nixos-option is an abstraction. There are rumors that in future module system will be rewritten in C++, so these implementation details may be no longer valid.

So I dunno... I would merge, but want to hear more opinions.

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

@nbp nbp Awaiting requested review from nbp

Assignees
No one assigned
Labels
6.topic: nixos 8.has: documentation 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
3 participants
@SRGOM @nixos-discourse @danbst