diff options
| author | Eelco Dolstra <eelco.dolstra@logicblox.com> | 2015-06-03 17:03:07 +0200 |
|---|---|---|
| committer | Eelco Dolstra <eelco.dolstra@logicblox.com> | 2015-06-03 17:05:10 +0200 |
| commit | 35ff30c73fa312990d88a74aa5951094ecd1b461 (patch) | |
| tree | a0d2c45d6ffcf1de53e4cbfbb9a320f3d5417d5f /doc/contributing.xml | |
| parent | 7c6b935b60128e700630561424a8bb1b80f4afac (diff) | |
| download | nixlib-35ff30c73fa312990d88a74aa5951094ecd1b461.tar nixlib-35ff30c73fa312990d88a74aa5951094ecd1b461.tar.gz nixlib-35ff30c73fa312990d88a74aa5951094ecd1b461.tar.bz2 nixlib-35ff30c73fa312990d88a74aa5951094ecd1b461.tar.lz nixlib-35ff30c73fa312990d88a74aa5951094ecd1b461.tar.xz nixlib-35ff30c73fa312990d88a74aa5951094ecd1b461.tar.zst nixlib-35ff30c73fa312990d88a74aa5951094ecd1b461.zip | |
Streamline contributing section
Diffstat (limited to 'doc/contributing.xml')
| -rw-r--r-- | doc/contributing.xml | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/contributing.xml b/doc/contributing.xml index f622845bf1a8..ee93be4447ac 100644 --- a/doc/contributing.xml +++ b/doc/contributing.xml @@ -4,16 +4,17 @@ <title>Contributing</title> -<para>If you make modifications to the manual, it's important to build the manual before contributing:</para> +<para>The DocBook sources of the Nixpkgs manual are in the <filename +xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> +subdirectory of the Nixpkgs repository. If you make modifications to +the manual, it's important to build it before committing. You can do that as follows: -<orderedlist> +<screen> +$ cd /path/to/nixpkgs +$ nix-build doc +</screen> - <listitem><para><command>$ git clone git://github.com/NixOS/nixpkgs.git</command></para></listitem> - - <listitem><para><command>$ nix-build -A manual nixpkgs/pkgs/top-level/release.nix</command></para></listitem> - - <listitem><para>Inside the built derivation you shall see <literal>manual/index.html</literal> file.</para></listitem> - -</orderedlist> +If the build succeeds, the manual will be in +<filename>./result/share/doc/nixpkgs/manual.html</filename>.</para> </chapter> |