about summary refs log tree commit diff
path: root/nixos/doc/manual/configuration/profiles.xml
diff options
context:
space:
mode:
authorDavid Izquierdo <david@izquierdofernandez.com>2018-10-25 10:15:25 +0200
committerDavid Izquierdo <david@izquierdofernandez.com>2018-11-06 12:55:37 +0100
commit57d9bc4ce2093c0815e3989f391b57297732d10d (patch)
treedcd91f607dbd38ca1d7c51b8c320e02a1a4a0ddf /nixos/doc/manual/configuration/profiles.xml
parenta7afcff928421b17c2c4b23ddd6e630c54f48854 (diff)
downloadnixlib-57d9bc4ce2093c0815e3989f391b57297732d10d.tar
nixlib-57d9bc4ce2093c0815e3989f391b57297732d10d.tar.gz
nixlib-57d9bc4ce2093c0815e3989f391b57297732d10d.tar.bz2
nixlib-57d9bc4ce2093c0815e3989f391b57297732d10d.tar.lz
nixlib-57d9bc4ce2093c0815e3989f391b57297732d10d.tar.xz
nixlib-57d9bc4ce2093c0815e3989f391b57297732d10d.tar.zst
nixlib-57d9bc4ce2093c0815e3989f391b57297732d10d.zip
Docs: init chapter Profiles with section All Hardware
Diffstat (limited to 'nixos/doc/manual/configuration/profiles.xml')
-rw-r--r--nixos/doc/manual/configuration/profiles.xml29
1 files changed, 29 insertions, 0 deletions
diff --git a/nixos/doc/manual/configuration/profiles.xml b/nixos/doc/manual/configuration/profiles.xml
new file mode 100644
index 000000000000..bf669174d665
--- /dev/null
+++ b/nixos/doc/manual/configuration/profiles.xml
@@ -0,0 +1,29 @@
+<chapter xmlns="http://docbook.org/ns/docbook"
+         xmlns:xlink="http://www.w3.org/1999/xlink"
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+         version="5.0"
+         xml:id="ch-profiles">
+ <title>Profiles</title>
+ <para>
+  In some cases, it may be desirable to take advantage of commonly-used,
+  predefined configurations provided by nixpkgs, but different from those that
+  come as default. This is a role fulfilled by NixOS's Profiles, which come as
+  files living in <filename>&lt;nixpkgs/nixos/modules/profiles&gt;</filename>.
+  That is to say, expected usage is to add them to the imports list of your
+  <filename>/etc/configuration.nix</filename> as such:
+ </para>
+ <programlisting>
+  imports = [
+   &lt;nixpkgs/nixos/modules/profiles/profile-name.nix&gt;
+  ];
+ </programlisting>
+ <para>
+  Even if some of these profiles seem only useful in the context of
+  install media, many are actually intended to be used in real installs.
+ </para>
+ <para>
+  What follows is a brief explanation on the purpose and use-case for each
+  profile. Detailing each option configured by each one is out of scope.
+ </para>
+ <xi:include href="profiles/all-hardware.xml" />
+</chapter>