diff options
| author | Graham Christensen <graham@grahamc.com> | 2018-04-28 04:15:16 -0400 |
|---|---|---|
| committer | Graham Christensen <graham@grahamc.com> | 2018-04-28 04:15:16 -0400 |
| commit | 74fcb1c770e3a5178a7ee089b3caf406f7bf94bf (patch) | |
| tree | baa54332cbeac2c98dd6858a61bb47615d894b84 /nixos | |
| parent | a77dc213a7825f5dd13c7989e38d82e64816d881 (diff) | |
nixos docs: include note about make for debugging the nixos docs
Diffstat (limited to 'nixos')
| -rw-r--r-- | nixos/doc/manual/development/writing-documentation.xml | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/nixos/doc/manual/development/writing-documentation.xml b/nixos/doc/manual/development/writing-documentation.xml index 59a287717acb..8b787fae1fe0 100644 --- a/nixos/doc/manual/development/writing-documentation.xml +++ b/nixos/doc/manual/development/writing-documentation.xml @@ -18,13 +18,25 @@ <para> The DocBook sources of the <xref linkend="book-nixos-manual"/> are in the <link xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual"><filename>nixos/doc/manual</filename></link> - 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: + subdirectory of the Nixpkgs repository. +</para> - <screen>nix-build nixos/release.nix -A manual.x86_64-linux</screen> +<para> + You can quickly validate your edits with <command>make</command>: </para> +<screen> + $ cd /path/to/nixpkgs/nixos/doc/manual + $ make +</screen> + +<para> + Once you are done making modifications to the manual, it's important + to build it before committing. You can do that as follows: +</para> + +<screen>nix-build nixos/release.nix -A manual.x86_64-linux</screen> + <para> When this command successfully finishes, it will tell you where the manual got generated. The HTML will be accessible through the |