* Fix grammar/spelling for some descriptions, and make them produce

well-formed XML in the manual again.

svn path=/nixos/trunk/; revision=13650
This commit is contained in:
Eelco Dolstra 2008-12-17 13:06:48 +00:00
parent 2f4b7d3e09
commit 43dc3f6baa

View File

@ -1672,9 +1672,11 @@ in
default = []; default = [];
example = [ "proxy_connect" { name = "php5_module"; path = "${pkgs.php}/modules/libphp5.so"; } ]; example = [ "proxy_connect" { name = "php5_module"; path = "${pkgs.php}/modules/libphp5.so"; } ];
description = '' description = ''
Loads additional modules either beeing distributed with apache. Specifies additional Apache modules. These can be specified
If the module is contained in a foreign package (such as php5_module) as a string in the case of modules distributed with Apache,
kse an attrset as given in the example. 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"; } 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"; } { 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. description = ''
nixos-checkout will update all working copies of the given repositories, The NixOS repository from which the system will be built.
nixos-rebuild will use the first item which has <command>nixos-checkout</command> will update all working
the attribute default = true falling back to the copies of the given repositories,
first item. The type defines the repository tool added <command>nixos-rebuild</command> will use the first item
to the path. It also defines a \"valid\" repository. which has the attribute <literal>default = true</literal>
If the target directory already exists and it's not falling back to the first item. The type defines the
valid it will be moved to the backup location repository tool added to the path. It also defines a "valid"
<filename>\${dir}-date</filename>. 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 For svn the default target and repositories are
<filename>/etc/nixos/nixos</filename> and <filename>/etc/nixos/nixos</filename> and
<filename>https://svn.nixos.org/repos/nix/nixos/trunk</filename>. <filename>https://svn.nixos.org/repos/nix/nixos/trunk</filename>.
For git repositories update is called after For git repositories update is called after initialization
initialization when the repo is initialized. when the repo is initialized. The initialize code is run
The initialize code is run from working directory from working directory dirname
dirname \$target and should create the directory <replaceable>target</replaceable> and should create the
<filename>\$target<filename>. (<command>git clone url nixos/nixpkgs/services</command> should do) directory
For the executables beeing used see <option>repoTypes</option> <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 { nixpkgs = mkOption {
@ -2567,8 +2573,13 @@ in
svn = { valid = "[ -d .svn ]"; env = [ pkgs.coreutils pkgs.subversion ]; }; 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 */ ]; }; 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. description = ''
If it's not it's moved to a backup directory"; 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 { manifests = mkOption {