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

lib/eval-config: document NIXOS_EXTRA_MODULE_PATH #31418

Merged
merged 1 commit into from Apr 28, 2018

Conversation

ryantm
Copy link
Member

@ryantm ryantm commented Nov 9, 2017

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.

Copy link
Member

@FRidh FRidh left a 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
Copy link
Member

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:
Copy link
Member

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
Copy link
Member

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:
Copy link
Member

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:

@ryantm
Copy link
Member Author

ryantm commented Nov 13, 2017

@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.

@ryantm
Copy link
Member Author

ryantm commented Nov 19, 2017

@FRidh Are you okay with it now?

@ryantm
Copy link
Member Author

ryantm commented Jan 21, 2018

@FRidh bump

@ryantm
Copy link
Member Author

ryantm commented Feb 19, 2018

bump

This adds some documentation about importing modules external to
Nixpkgs, which provides context for documenting
NIXOS_EXTRA_MODULE_PATH.

Closes NixOS#30376
@ryantm
Copy link
Member Author

ryantm commented Feb 20, 2018

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.

@ryantm
Copy link
Member Author

ryantm commented Apr 2, 2018

@FRidh nudge

@grahamc grahamc merged commit 68d48ce into NixOS:master Apr 28, 2018
@grahamc
Copy link
Member

grahamc commented Apr 28, 2018

merged and backported while boarding a plane. thanks!

@ryantm ryantm deleted the doc-nixos-extra-module-path branch April 28, 2018 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants