JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

nixos docs: include note about make for debugging the nixos docs

Browse Source
This commit is contained in:
Graham Christensen 2018-04-28 04:15:16 -04:00
parent a77dc213a7
commit 74fcb1c770
No known key found for this signature in database
GPG Key ID: ACA1C1D120C83D5C
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
nixos/doc/manual/development/writing-documentation.xml
View File

@ -18,13 +18,25 @@
<para> <para>
The DocBook sources of the <xref linkend="book-nixos-manual"/> are in the 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> <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 subdirectory of the Nixpkgs repository.
the manual, it's important to build it before committing. You can do
that as follows:
<screen>nix-build nixos/release.nix -A manual.x86_64-linux</screen>
</para> </para>
<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> <para>
When this command successfully finishes, it will tell you where the When this command successfully finishes, it will tell you where the
manual got generated. The HTML will be accessible through the manual got generated. The HTML will be accessible through the