diff options
| author | Domen Kožar <domen@dev.si> | 2014-07-27 15:21:17 +0200 |
|---|---|---|
| committer | Domen Kožar <domen@dev.si> | 2014-07-27 15:21:17 +0200 |
| commit | 9471af0f8a15c9aa7d7875ac810a95c81e60bcb0 (patch) | |
| tree | 272c11df58ae28c2cb94367c5bf0699959575af1 | |
| parent | 6c219636da858f625ba490523eb6952c4bb039f8 (diff) | |
| download | nixlib-9471af0f8a15c9aa7d7875ac810a95c81e60bcb0.tar nixlib-9471af0f8a15c9aa7d7875ac810a95c81e60bcb0.tar.gz nixlib-9471af0f8a15c9aa7d7875ac810a95c81e60bcb0.tar.bz2 nixlib-9471af0f8a15c9aa7d7875ac810a95c81e60bcb0.tar.lz nixlib-9471af0f8a15c9aa7d7875ac810a95c81e60bcb0.tar.xz nixlib-9471af0f8a15c9aa7d7875ac810a95c81e60bcb0.tar.zst nixlib-9471af0f8a15c9aa7d7875ac810a95c81e60bcb0.zip | |
doc: add section how to build the manual
| -rw-r--r-- | doc/contributing.xml | 21 | ||||
| -rw-r--r-- | doc/manual.xml | 1 |
2 files changed, 22 insertions, 0 deletions
diff --git a/doc/contributing.xml b/doc/contributing.xml new file mode 100644 index 000000000000..bcea404baee0 --- /dev/null +++ b/doc/contributing.xml @@ -0,0 +1,21 @@ +<chapter xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xml:id="chap-contributing"> + +<title>Contributing</title> + +<para>If you make modifications to the manual, it's important to build the manual before contributing:</para> + +<orderedlist> + + <listitem><para><command>$ git clone git://github.com/NixOS/nixpkgs.git</command></para></listitem> + + <listitem><para><command>$ cd nixpkgs/pkgs/top-level</command></para></listitem> + + <listitem><para><command>$ nix-build -A tarball release.nix</command></para></listitem> + + <listitem><para>Inside the built derivation you shall see <literal>manual/index.html</literal> file.</para></listitem> + +</orderedlist> + +</chapter> diff --git a/doc/manual.xml b/doc/manual.xml index d2c07859b281..145e3e12dd92 100644 --- a/doc/manual.xml +++ b/doc/manual.xml @@ -32,6 +32,7 @@ <xi:include href="language-support.xml" /> <xi:include href="package-notes.xml" /> <xi:include href="coding-conventions.xml" /> + <xi:include href="contributing.xml" /> </book> |