about summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorBobby Rong <rjl931189261@126.com>2021-09-08 15:35:45 +0800
committerBobby Rong <rjl931189261@126.com>2021-09-08 16:35:17 +0800
commit785d40d4d872a13642eb7eba7a5bc57f6ba5cdc5 (patch)
treedf72065a230f78a08a21f70a1eff329df92ef428 /nixos
parent2e808c8144bc864d8b837cc59ffbf52dc360a1d4 (diff)
downloadnixlib-785d40d4d872a13642eb7eba7a5bc57f6ba5cdc5.tar
nixlib-785d40d4d872a13642eb7eba7a5bc57f6ba5cdc5.tar.gz
nixlib-785d40d4d872a13642eb7eba7a5bc57f6ba5cdc5.tar.bz2
nixlib-785d40d4d872a13642eb7eba7a5bc57f6ba5cdc5.tar.lz
nixlib-785d40d4d872a13642eb7eba7a5bc57f6ba5cdc5.tar.xz
nixlib-785d40d4d872a13642eb7eba7a5bc57f6ba5cdc5.tar.zst
nixlib-785d40d4d872a13642eb7eba7a5bc57f6ba5cdc5.zip
nixos: nixos/doc/manual/configuration/profiles.xml to CommonMark
Diffstat (limited to 'nixos')
-rw-r--r--nixos/doc/manual/configuration/configuration.xml2
-rw-r--r--nixos/doc/manual/configuration/profiles.chapter.md34
-rw-r--r--nixos/doc/manual/configuration/profiles.xml39
-rw-r--r--nixos/doc/manual/from_md/configuration/profiles.chapter.xml38
4 files changed, 73 insertions, 40 deletions
diff --git a/nixos/doc/manual/configuration/configuration.xml b/nixos/doc/manual/configuration/configuration.xml
index 58a2b8400597..b04316cfa48e 100644
--- a/nixos/doc/manual/configuration/configuration.xml
+++ b/nixos/doc/manual/configuration/configuration.xml
@@ -25,7 +25,7 @@
  <xi:include href="../from_md/configuration/linux-kernel.chapter.xml" />
  <xi:include href="../from_md/configuration/subversion.chapter.xml" />
  <xi:include href="../generated/modules.xml" xpointer="xpointer(//section[@id='modules']/*)" />
- <xi:include href="profiles.xml" />
+ <xi:include href="../from_md/configuration/profiles.chapter.xml" />
  <xi:include href="../from_md/configuration/kubernetes.chapter.xml" />
 <!-- Apache; libvirtd virtualisation -->
 </part>
diff --git a/nixos/doc/manual/configuration/profiles.chapter.md b/nixos/doc/manual/configuration/profiles.chapter.md
new file mode 100644
index 000000000000..b4ae1b7d3faa
--- /dev/null
+++ b/nixos/doc/manual/configuration/profiles.chapter.md
@@ -0,0 +1,34 @@
+# Profiles {#ch-profiles}
+
+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 `<nixpkgs/nixos/modules/profiles>`. That
+is to say, expected usage is to add them to the imports list of your
+`/etc/configuration.nix` as such:
+
+```nix
+imports = [
+  <nixpkgs/nixos/modules/profiles/profile-name.nix>
+];
+```
+
+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.
+
+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.
+
+```{=docbook}
+<xi:include href="profiles/all-hardware.section.xml" />
+<xi:include href="profiles/base.section.xml" />
+<xi:include href="profiles/clone-config.section.xml" />
+<xi:include href="profiles/demo.section.xml" />
+<xi:include href="profiles/docker-container.section.xml" />
+<xi:include href="profiles/graphical.section.xml" />
+<xi:include href="profiles/hardened.section.xml" />
+<xi:include href="profiles/headless.section.xml" />
+<xi:include href="profiles/installation-device.section.xml" />
+<xi:include href="profiles/minimal.section.xml" />
+<xi:include href="profiles/qemu-guest.section.xml" />
+```
diff --git a/nixos/doc/manual/configuration/profiles.xml b/nixos/doc/manual/configuration/profiles.xml
deleted file mode 100644
index 6994c7e31705..000000000000
--- a/nixos/doc/manual/configuration/profiles.xml
+++ /dev/null
@@ -1,39 +0,0 @@
-<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="../from_md/configuration/profiles/all-hardware.section.xml" />
- <xi:include href="../from_md/configuration/profiles/base.section.xml" />
- <xi:include href="../from_md/configuration/profiles/clone-config.section.xml" />
- <xi:include href="../from_md/configuration/profiles/demo.section.xml" />
- <xi:include href="../from_md/configuration/profiles/docker-container.section.xml" />
- <xi:include href="../from_md/configuration/profiles/graphical.section.xml" />
- <xi:include href="../from_md/configuration/profiles/hardened.section.xml" />
- <xi:include href="../from_md/configuration/profiles/headless.section.xml" />
- <xi:include href="../from_md/configuration/profiles/installation-device.section.xml" />
- <xi:include href="../from_md/configuration/profiles/minimal.section.xml" />
- <xi:include href="../from_md/configuration/profiles/qemu-guest.section.xml" />
-</chapter>
diff --git a/nixos/doc/manual/from_md/configuration/profiles.chapter.xml b/nixos/doc/manual/from_md/configuration/profiles.chapter.xml
new file mode 100644
index 000000000000..6f5fc130c6a0
--- /dev/null
+++ b/nixos/doc/manual/from_md/configuration/profiles.chapter.xml
@@ -0,0 +1,38 @@
+<chapter xmlns="http://docbook.org/ns/docbook"  xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" 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
+    <literal>&lt;nixpkgs/nixos/modules/profiles&gt;</literal>. That is
+    to say, expected usage is to add them to the imports list of your
+    <literal>/etc/configuration.nix</literal> as such:
+  </para>
+  <programlisting language="bash">
+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.section.xml" />
+  <xi:include href="profiles/base.section.xml" />
+  <xi:include href="profiles/clone-config.section.xml" />
+  <xi:include href="profiles/demo.section.xml" />
+  <xi:include href="profiles/docker-container.section.xml" />
+  <xi:include href="profiles/graphical.section.xml" />
+  <xi:include href="profiles/hardened.section.xml" />
+  <xi:include href="profiles/headless.section.xml" />
+  <xi:include href="profiles/installation-device.section.xml" />
+  <xi:include href="profiles/minimal.section.xml" />
+  <xi:include href="profiles/qemu-guest.section.xml" />
+</chapter>