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
lib/eval-config: document NIXOS_EXTRA_MODULE_PATH #31418
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR. I think the text needs to be more neutral.
|
||
<title>Importing Modules</title> | ||
|
||
<para>Sometimes NixOS modules exist outside of Nixpkgs, and you want |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid using "you".
Modules that exist outside of Nixpkgs can be imported in a NixOS configuration.
</para> | ||
|
||
<para> | ||
The simplest way to do this is to import the module: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The module can be imported as follows:
</programlisting> | ||
|
||
<para> | ||
If the list of modules you need to import grows large, you can move |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whether the list grows large or not is irrelevant; it's always possible to keep it outside. I would drop this example as it doesn't add anything.
an absolute path to a NixOS module that is included alongside the | ||
Nixpkgs NixOS modules. Like any NixOS module, this module can import | ||
additional modules. Using the same module list as the previous | ||
example, you could do: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Drop
Using the same module list as the previous example, you could do:
@FRidh Thanks for the feedback. I think I've incorporated all of your review suggestions. Please take another look. I will squash the commits together when the reviewers are satisfied. |
@FRidh Are you okay with it now? |
@FRidh bump |
bump |
0fac426
to
3d6c852
Compare
This adds some documentation about importing modules external to Nixpkgs, which provides context for documenting NIXOS_EXTRA_MODULE_PATH. Closes NixOS#30376
3d6c852
to
1cc97be
Compare
Since I haven't received any feedback in a while, I went ahead and squashed the commits. So, I believe it's ready to merge. |
@FRidh nudge |
merged and backported while boarding a plane. thanks! |
This adds some documentation about importing modules external to
Nixpkgs, which provides context for documenting
NIXOS_EXTRA_MODULE_PATH.
Closes #30376
Motivation for this change
NIXOS_EXTRA_MODULE_PATH was undocumented.
Things done
Built manual and proofread the new section.