From 74fcb1c770e3a5178a7ee089b3caf406f7bf94bf Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Sat, 28 Apr 2018 04:15:16 -0400 Subject: [PATCH] nixos docs: include note about make for debugging the nixos docs --- .../development/writing-documentation.xml | 22 ++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/nixos/doc/manual/development/writing-documentation.xml b/nixos/doc/manual/development/writing-documentation.xml index 59a287717ac..8b787fae1fe 100644 --- a/nixos/doc/manual/development/writing-documentation.xml +++ b/nixos/doc/manual/development/writing-documentation.xml @@ -18,13 +18,25 @@ The DocBook sources of the are in the nixos/doc/manual - 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: - - nix-build nixos/release.nix -A manual.x86_64-linux + subdirectory of the Nixpkgs repository. + + You can quickly validate your edits with make: + + + + $ cd /path/to/nixpkgs/nixos/doc/manual + $ make + + + + Once you are done making modifications to the manual, it's important + to build it before committing. You can do that as follows: + + +nix-build nixos/release.nix -A manual.x86_64-linux + When this command successfully finishes, it will tell you where the manual got generated. The HTML will be accessible through the