From a10aa82e8aaee11d8e8b8c5e7e19f758a7553bf0 Mon Sep 17 00:00:00 2001 From: Midnight Veil Date: Mon, 19 Jun 2023 19:37:28 +1000 Subject: [PATCH] docs: Document osConfig module argument (#4103) As mentioned https://github.com/nix-community/home-manager/issues/393#issuecomment-1259996423. Otherwise only documented in source code, which isn't very findable. --- docs/installation.adoc | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/installation.adoc b/docs/installation.adoc index 5241e9247..da596e167 100644 --- a/docs/installation.adoc +++ b/docs/installation.adoc @@ -219,6 +219,15 @@ the dependency on `NIX_PATH`, which is otherwise used for importing Nixpkgs. ==== +[NOTE] +==== +Home Manager will pass `osConfig` as a module argument to any modules +you create. This contains the system's NixOS configuration. + +[source,nix] +{ lib, pkgs, osConfig, ... }: +==== + Once installed you can see <> for a more detailed description of Home Manager and how to use it. @@ -325,5 +334,14 @@ the dependency on `NIX_PATH`, which is otherwise used for importing Nixpkgs. ==== +[NOTE] +==== +Home Manager will pass `osConfig` as a module argument to any modules +you create. This contains the system's nix-darwin configuration. + +[source,nix] +{ lib, pkgs, osConfig, ... }: +==== + Once installed you can see <> for a more detailed description of Home Manager and how to use it.