From 8e0f2fd7c683de38f9c6fe48f742bd4e5c13f7df Mon Sep 17 00:00:00 2001
From: Eelco Dolstra <eelco.dolstra@logicblox.com>
Date: Tue, 23 Jan 2007 11:06:31 +0000
Subject: [PATCH] * Properly render DocBook in option descriptions.

svn path=/nixos/trunk/; revision=7765
---
 doc/manual/options-to-docbook.xsl |  4 +++-
 system/options.nix                | 17 +++++++++--------
 2 files changed, 12 insertions(+), 9 deletions(-)

diff --git a/doc/manual/options-to-docbook.xsl b/doc/manual/options-to-docbook.xsl
index bad74c3f59dc..5ed80f10bda2 100644
--- a/doc/manual/options-to-docbook.xsl
+++ b/doc/manual/options-to-docbook.xsl
@@ -3,6 +3,7 @@
 <xsl:stylesheet version="1.0"
                 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
                 xmlns:str="http://exslt.org/strings"
+                xmlns:xlink="http://www.w3.org/1999/xlink"
                 xmlns="http://docbook.org/ns/docbook"
                 extension-element-prefixes="str"
                 >
@@ -29,7 +30,8 @@
              </term>
 
              <listitem><para>
-               <xsl:value-of select="attr[@name = 'description']/string/@value" />
+               <xsl:value-of disable-output-escaping="yes"
+                             select="attr[@name = 'description']/string/@value" />
              </para></listitem>
 
           </varlistentry>
diff --git a/system/options.nix b/system/options.nix
index b20ebf9eecae..827c50eef5a7 100644
--- a/system/options.nix
+++ b/system/options.nix
@@ -76,7 +76,7 @@
     description = "
       The kernel parameters.  If you want to add additional
       parameters, it's best to set
-      <option>boot.extraKernelParams</options>.
+      <option>boot.extraKernelParams</option>.
     ";
   }
 
@@ -116,7 +116,7 @@
       the boot process.  That is, these modules are not included in
       the initial ramdisk, so they'd better not be required for
       mounting the root file system.  Add them to
-      <option>boot.initrd.extraKernelModules</options> if they are.
+      <option>boot.initrd.extraKernelModules</option> if they are.
     ";
   }
 
@@ -143,7 +143,7 @@
       dependencies of the modules list here are included
       automatically.  If you want to add additional
       modules, it's best to set
-      <option>boot.initrd.extraKernelModules</options>.
+      <option>boot.initrd.extraKernelModules</option>.
     ";
   }
 
@@ -154,7 +154,7 @@
     description = "
       Additional kernel modules for the initial ramdisk.  These are
       loaded before the modules listed in
-      <option>boot.initrd.kernelModules</options>, so they take
+      <option>boot.initrd.kernelModules</option>, so they take
       precedence.
     ";
   }
@@ -248,7 +248,7 @@
       should be an attribute set specifying either the path of the
       swap device or file (<literal>device</literal>) or the label
       of the swap device (<literal>label</literal>, see
-      <command>mkswap -L</command</command>).  Using a label is
+      <command>mkswap -L</command>).  Using a label is
       recommended.
     ";
   }
@@ -290,7 +290,7 @@
     };
     description = "
       The default theme for the virtual consoles.  Themes can be found
-      at http://www.bootsplash.de/.
+      at <link xlink:href='http://www.bootsplash.de/' />.
     ";
   }
 
@@ -376,7 +376,8 @@
     default = true;
     description = "
       Whether to enable the SFTP subsystem in the SSH daemon.  This
-      enables the use of commands such as sftp(1) and sshfs.
+      enables the use of commands such as <command>sftp</command> and
+      <command>sshfs</command>.
     ";
   }
 
@@ -493,7 +494,7 @@
     description = "
       Directory for Apache's transient runtime state (such as PID
       files).  It is created automatically.  Note that the default,
-      /var/run/httpd, is deleted at boot time.
+      <filename>/var/run/httpd</filename>, is deleted at boot time.
     ";
   }