From 35ff30c73fa312990d88a74aa5951094ecd1b461 Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Wed, 3 Jun 2015 17:03:07 +0200 Subject: [PATCH] Streamline contributing section --- doc/contributing.xml | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/doc/contributing.xml b/doc/contributing.xml index f622845bf1a..ee93be4447a 100644 --- a/doc/contributing.xml +++ b/doc/contributing.xml @@ -4,16 +4,17 @@ Contributing -If you make modifications to the manual, it's important to build the manual before contributing: +The DocBook sources of the Nixpkgs manual are in the doc +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: - + +$ cd /path/to/nixpkgs +$ nix-build doc + - $ git clone git://github.com/NixOS/nixpkgs.git - - $ nix-build -A manual nixpkgs/pkgs/top-level/release.nix - - Inside the built derivation you shall see manual/index.html file. - - +If the build succeeds, the manual will be in +./result/share/doc/nixpkgs/manual.html.