From 43dc3f6baad3ce4a17b11204a892baf7c39ff12a Mon Sep 17 00:00:00 2001
From: Eelco Dolstra <eelco.dolstra@logicblox.com>
Date: Wed, 17 Dec 2008 13:06:48 +0000
Subject: [PATCH] * Fix grammar/spelling for some descriptions, and make them
 produce   well-formed XML in the manual again.

svn path=/nixos/trunk/; revision=13650
---
 system/options.nix | 67 +++++++++++++++++++++++++++-------------------
 1 file changed, 39 insertions(+), 28 deletions(-)

diff --git a/system/options.nix b/system/options.nix
index 05189dbd23bf..6f4455148576 100644
--- a/system/options.nix
+++ b/system/options.nix
@@ -1672,9 +1672,11 @@ in
         default = [];
         example = [ "proxy_connect" { name = "php5_module"; path = "${pkgs.php}/modules/libphp5.so"; } ];
         description = ''
-          Loads additional modules either beeing distributed with apache.
-          If the module is contained in a foreign package (such as php5_module)
-          kse an attrset as given in the example.
+          Specifies additional Apache modules.  These can be specified
+          as a string in the case of modules distributed with Apache,
+          or as an attribute set specifying the
+          <varname>name</varname> and <varname>path</varname> of the
+          module.
         '';
       };
 
@@ -2530,25 +2532,29 @@ in
         example = [ { type = "svn"; url = "https://svn.nixos.org/repos/nix/nixos/branches/stdenv-updates"; target = "/etc/nixos/nixos-stdenv-updates"; }
                     { type = "git"; initialize = ''git clone git://mawercer.de/nixos $target''; update = "git pull origin"; target = "/etc/nixos/nixos-git"; }
                   ];
-        description = "The NixOS repository from which the system will be build. 
-                       nixos-checkout will update all working copies of the given repositories,
-                       nixos-rebuild will use the first item which has
-                       the attribute default = true falling back to the
-                       first item. The type defines the repository tool added
-                       to the path. It also defines a \"valid\" repository.
-                       If the target directory already exists and it's not
-                       valid it will be moved to the backup location
-                       <filename>\${dir}-date</filename>.
-                       For svn the default target and repositories are
-                       <filename>/etc/nixos/nixos</filename> and
-                       <filename>https://svn.nixos.org/repos/nix/nixos/trunk</filename>.
-                       For git repositories update is called after
-                       initialization when the repo is initialized.
-                       The initialize code is run from working directory
-                       dirname \$target and should create the directory
-                       <filename>\$target<filename>. (<command>git clone url nixos/nixpkgs/services</command> should do)
-                       For the executables beeing used see <option>repoTypes</option>
-                       ";
+        description = ''
+          The NixOS repository from which the system will be built.
+          <command>nixos-checkout</command> will update all working
+          copies of the given repositories,
+          <command>nixos-rebuild</command> will use the first item
+          which has the attribute <literal>default = true</literal>
+          falling back to the first item. The type defines the
+          repository tool added to the path. It also defines a "valid"
+          repository.  If the target directory already exists and it's
+          not valid it will be moved to the backup location
+          <filename><replaceable>dir</replaceable>-date</filename>.
+          For svn the default target and repositories are
+          <filename>/etc/nixos/nixos</filename> and
+          <filename>https://svn.nixos.org/repos/nix/nixos/trunk</filename>.
+          For git repositories update is called after initialization
+          when the repo is initialized.  The initialize code is run
+          from working directory dirname
+          <replaceable>target</replaceable> and should create the
+          directory
+          <filename><replaceable>dir</replaceable></filename>. (<command>git
+          clone url nixos/nixpkgs/services</command> should do) For
+          the executables used see <option>repoTypes</option>.
+        '';
       };
 
       nixpkgs = mkOption {
@@ -2563,12 +2569,17 @@ in
     };
 
     repoTypes = mkOption {
-        default = {
-          svn = { valid = "[ -d .svn ]"; env = [ pkgs.coreutils pkgs.subversion ]; };
-          git = { valid = "[ -d .git ]"; env = [ pkgs.coreutils pkgs.git pkgs.gnused /*  FIXME: use full path to sed in nix-pull */ ]; };
-        };
-        description = "defines PATH environment and when directory is considered beeing a valid repository.
-              If it's not it's moved to a backup directory";
+      default = {
+        svn = { valid = "[ -d .svn ]"; env = [ pkgs.coreutils pkgs.subversion ]; };
+        git = { valid = "[ -d .git ]"; env = [ pkgs.coreutils pkgs.git pkgs.gnused /*  FIXME: use full path to sed in nix-pull */ ]; };
+      };
+      description = ''
+        Defines, for each supported version control system
+        (e.g. <literal>git</literal>), the dependencies for the
+        mechanism, as well as a test used to determine whether a
+        directory is a checkout created by that version control
+        system.
+      '';
     };
 
     manifests = mkOption {