Improve NixOS module #1059

erikarvstedt · 2020-03-01T16:10:44Z

No description provided.

erikarvstedt · 2020-03-04T23:38:45Z

Rebased.

lovesegfault · 2020-03-06T16:55:40Z

Pinging @rycee for review

cole-h

I can't comment on the functionality of the code, but I have a few suggestions I'd like to make.

cole-h · 2020-03-06T17:47:59Z

README.md

+For a more systematic documentation of Home Manager and all available
+options please see the [Home Manager manual][manual].


This wording feels awkward, to me. If it needs to be changed at all, maybe something more along the lines of:

Suggested change

For a more systematic documentation of Home Manager and all available

options please see the [Home Manager manual][manual].

For a more systematic overview of Home Manager and its available

options, please see the [Home Manager manual][manual].

Fixed. Editing help from native speakers is highly welcome, thank you!

cole-h · 2020-03-06T17:49:33Z

doc/installation.xml

+  <note>
+   <para>
+    By default, Home Manager modules use a private <literal>pkgs</literal> instance
+    that's configured via the <option>nixpkgs</option> options.


Pretty nitpick-y, but I hold to the belief that documentation should be more formal (and thus refrain from using contractions and other colloquialisms).

Suggested change

that's configured via the <option>nixpkgs</option> options.

that is configured via the <option>nixpkgs</option> options.

cole-h · 2020-03-06T17:51:54Z

doc/installation.xml

+
+  <para>
+   To easily set Home Manager options for a specific user, use the following recipe.
+   This is useful when a user config is composed through multiple NixOS modules.


Not necessary, but sounds better, IMHO.

Suggested change

This is useful when a user config is composed through multiple NixOS modules.

This is especially useful when a user's configuration is composed through

multiple NixOS modules.

modules/modules.nix

nixos/default.nix

modules/misc/news.nix

rycee · 2020-03-07T12:24:18Z

nixos/default.nix

@@ -45,6 +46,11 @@ in {
        <option>users.users.‹name?›.packages</option> option.
      '';

+      useGlobalPkgs = mkEnableOption ''
+        using <literal>pkgs</literal> from the NixOS modules in Home Manager.


Nothing important but perhaps

Suggested change

using <literal>pkgs</literal> from the NixOS modules in Home Manager.

using the system configuration's <literal>pkgs</literal> argument in Home Manager.

or something would be more clear?

rycee · 2020-03-07T12:27:03Z

modules/modules.nix

@@ -5,6 +5,9 @@

  # Whether to enable module type checking.
 , check ? true
+
+# If disabled, the pkgs passed to this function are used instead


Suggested change

# If disabled, the pkgs passed to this function are used instead

# If disabled, the pkgs attribute passed to this function is used instead.

rycee · 2020-03-07T12:27:27Z

modules/modules.nix

+      _module.args.pkgs = lib.mkDefault pkgs;
+      _module.check = check;
+      lib = lib.hm;
+    } // optionalAttrs (useNixpkgsModule) {


Suggested change

} // optionalAttrs (useNixpkgsModule) {

} // optionalAttrs useNixpkgsModule {

The main manual page is highly relevant and should be easily discoverable from the README. PR #1059 Fixes #1048

rycee · 2020-03-07T12:37:30Z

I cherry picked the README: add link to main manual page commit to master in c7b4378.

rycee · 2020-03-07T12:47:25Z

doc/installation.xml

+  <note>
+   <para>
+    By default, Home Manager modules use a private <literal>pkgs</literal> instance
+    that is configured via the <option>nixpkgs</option> options.


Suggested change

that is configured via the <option>nixpkgs</option> options.

that is configured via the <option>home-manager.users.<name?>.nixpkgs</option> options.

rycee · 2020-03-07T12:49:15Z

doc/installation.xml

+    To disable these options and to use the global <literal>pkgs</literal> from
+    the NixOS modules, set


Suggested change

To disable these options and to use the global <literal>pkgs</literal> from

the NixOS modules, set

To instead use the global <literal>pkgs</literal> that is configured via

the <option>nixpkgs</option> options, set

doc/installation.xml

rycee · 2020-03-07T13:04:18Z

doc/installation.xml

+   </para>
+  </note>
+
+  <para>


I would suggest removing this commit since it is orthogonal to the general PR and I think does not fit in the installation section. Maybe could go in a "tips and tricks" section (in a separate PR) or even on the wiki?

I've removed it. Where would you add that tips and tricks section?

I guess there should be a new chapter called something like "NixOS Integration", with a section "Tips and Tricks" where this would go into a subsection.

I think there you could also have more space to write text surrounding this use pattern since it is dealing with more advanced concepts such as defining your own options and using a function like mkAliasDefinitions.

erikarvstedt · 2020-03-07T13:04:23Z

Here's a rebased version of this PR.

Needed for the following commit.

PR #1059

rycee · 2020-03-07T13:28:09Z

Thanks! Added to master in efbe138.

The main manual page is highly relevant and should be easily discoverable from the README. PR nix-community#1059 Fixes nix-community#1048

PR nix-community#1059

erikarvstedt force-pushed the improve-nixos-module branch from c5fbb96 to 9afabd0 Compare March 4, 2020 23:38

erikarvstedt mentioned this pull request Mar 6, 2020

nixos module imports separate <nixpkgs> #616

Closed

cole-h suggested changes Mar 6, 2020

View reviewed changes

erikarvstedt force-pushed the improve-nixos-module branch from 9afabd0 to 248dbae Compare March 6, 2020 19:23

rycee reviewed Mar 7, 2020

View reviewed changes

rycee pushed a commit that referenced this pull request Mar 7, 2020

README: add link to main manual page

c7b4378

The main manual page is highly relevant and should be easily discoverable from the README. PR #1059 Fixes #1048

rycee reviewed Mar 7, 2020

View reviewed changes

doc/installation.xml Outdated Show resolved Hide resolved

erikarvstedt force-pushed the improve-nixos-module branch from 248dbae to 45b997a Compare March 7, 2020 13:02

rycee reviewed Mar 7, 2020

View reviewed changes

erikarvstedt added 2 commits March 7, 2020 14:06

extract 'config' attr

3938178

Needed for the following commit.

nixos integration: add option 'useGlobalPkgs'

f209fbf

erikarvstedt force-pushed the improve-nixos-module branch from 45b997a to f209fbf Compare March 7, 2020 13:10

rycee pushed a commit that referenced this pull request Mar 7, 2020

nixos integration: add option 'useGlobalPkgs'

efbe138

PR #1059

rycee closed this Mar 7, 2020

jorsn pushed a commit to jorsn/home-manager that referenced this pull request Apr 25, 2020

README: add link to main manual page

f5021d7

The main manual page is highly relevant and should be easily discoverable from the README. PR nix-community#1059 Fixes nix-community#1048

jorsn pushed a commit to jorsn/home-manager that referenced this pull request Apr 25, 2020

nixos integration: add option 'useGlobalPkgs'

ae4e337

PR nix-community#1059

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve NixOS module #1059

Improve NixOS module #1059

erikarvstedt commented Mar 1, 2020

erikarvstedt commented Mar 4, 2020

lovesegfault commented Mar 6, 2020

cole-h left a comment

cole-h Mar 6, 2020

erikarvstedt Mar 6, 2020

cole-h Mar 6, 2020

erikarvstedt Mar 6, 2020

cole-h Mar 6, 2020

erikarvstedt Mar 6, 2020

rycee Mar 7, 2020

rycee Mar 7, 2020 •

edited

Loading

rycee Mar 7, 2020

rycee commented Mar 7, 2020

rycee Mar 7, 2020

rycee Mar 7, 2020 •

edited

Loading

rycee Mar 7, 2020

erikarvstedt Mar 7, 2020

rycee Mar 7, 2020

erikarvstedt commented Mar 7, 2020

rycee commented Mar 7, 2020

		For a more systematic documentation of Home Manager and all available
		options please see the [Home Manager manual][manual].

	that's configured via the <option>nixpkgs</option> options.
	that is configured via the <option>nixpkgs</option> options.

	This is useful when a user config is composed through multiple NixOS modules.
	This is especially useful when a user's configuration is composed through
	multiple NixOS modules.

	using <literal>pkgs</literal> from the NixOS modules in Home Manager.
	using the system configuration's <literal>pkgs</literal> argument in Home Manager.

	# If disabled, the pkgs passed to this function are used instead
	# If disabled, the pkgs attribute passed to this function is used instead.

	} // optionalAttrs (useNixpkgsModule) {
	} // optionalAttrs useNixpkgsModule {

	that is configured via the <option>nixpkgs</option> options.
	that is configured via the <option>home-manager.users.<name?>.nixpkgs</option> options.

		To disable these options and to use the global <literal>pkgs</literal> from
		the NixOS modules, set

+                 </para>
+                </note>
+                <para>

Improve NixOS module #1059

Improve NixOS module #1059

Conversation

erikarvstedt commented Mar 1, 2020

erikarvstedt commented Mar 4, 2020

lovesegfault commented Mar 6, 2020

cole-h left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rycee Mar 7, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rycee commented Mar 7, 2020

Choose a reason for hiding this comment

rycee Mar 7, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erikarvstedt commented Mar 7, 2020

rycee commented Mar 7, 2020

rycee Mar 7, 2020 •

edited

Loading

rycee Mar 7, 2020 •

edited

Loading