diff options
| author | Graham Christensen <graham@grahamc.com> | 2018-03-24 22:10:55 -0400 |
|---|---|---|
| committer | Graham Christensen <graham@grahamc.com> | 2018-03-25 19:52:08 -0400 |
| commit | f67ea4a6d0b14a61af3ccd98ef1a37ce870162e1 (patch) | |
| tree | 1beca5e4d50e711797be4f19401e4a1b160a9356 /doc/contributing.xml | |
| parent | 7e25ff7106f00bdca9957b1109e2fd9beca86ea1 (diff) | |
| download | nixpkgs-f67ea4a6d0b14a61af3ccd98ef1a37ce870162e1.tar nixpkgs-f67ea4a6d0b14a61af3ccd98ef1a37ce870162e1.tar.gz nixpkgs-f67ea4a6d0b14a61af3ccd98ef1a37ce870162e1.tar.bz2 nixpkgs-f67ea4a6d0b14a61af3ccd98ef1a37ce870162e1.tar.lz nixpkgs-f67ea4a6d0b14a61af3ccd98ef1a37ce870162e1.tar.xz nixpkgs-f67ea4a6d0b14a61af3ccd98ef1a37ce870162e1.tar.zst nixpkgs-f67ea4a6d0b14a61af3ccd98ef1a37ce870162e1.zip | |
Document shell.nix / xmloscopy / make for the nixpkgs docs
Diffstat (limited to 'doc/contributing.xml')
| -rw-r--r-- | doc/contributing.xml | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/doc/contributing.xml b/doc/contributing.xml index a83059aa36e..8eed9c5416e 100644 --- a/doc/contributing.xml +++ b/doc/contributing.xml @@ -6,12 +6,28 @@ <para>The DocBook sources of the Nixpkgs manual are in the <filename xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> -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> + +<para>You can quickly check your edits with <command>make</command>:</para> + +<screen> + $ cd /path/to/nixpkgs/doc + $ nix-shell + [nix-shell]$ make +</screen> + +<para>If you experience problems, run <command>xmloscopy --docbook5 +./manual.xml ./manual-full.xml</command> inside the nix-shell to help +understand the docbook errors.</para> + +<para>After making modifications to the manual, it's important to +build it before committing. You can do that as follows: <screen> -$ cd /path/to/nixpkgs -$ nix-build doc + $ cd /path/to/nixpkgs/doc + $ nix-shell + [nix-shell]$ make clean + [nix-shell]$ nix-build . </screen> If the build succeeds, the manual will be in |