diff options
Diffstat (limited to 'doc/contributing.xml')
| -rw-r--r-- | doc/contributing.xml | 15 |
1 files changed, 5 insertions, 10 deletions
diff --git a/doc/contributing.xml b/doc/contributing.xml index 523c1c9c8f03..b0266043775f 100644 --- a/doc/contributing.xml +++ b/doc/contributing.xml @@ -3,10 +3,8 @@ xml:id="chap-contributing"> <title>Contributing to this documentation</title> <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. + 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. </para> <para> You can quickly check your edits with <command>make</command>: @@ -17,19 +15,16 @@ xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> <prompt>[nix-shell]$ </prompt>make </screen> <para> - If you experience problems, run <command>make debug</command> to help - understand the docbook errors. + If you experience problems, run <command>make debug</command> 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: + After making modifications to the manual, it's important to build it before committing. You can do that as follows: <screen> <prompt>$ </prompt>cd /path/to/nixpkgs/doc <prompt>$ </prompt>nix-shell <prompt>[nix-shell]$ </prompt>make clean <prompt>[nix-shell]$ </prompt>nix-build . </screen> - If the build succeeds, the manual will be in - <filename>./result/share/doc/nixpkgs/manual.html</filename>. + If the build succeeds, the manual will be in <filename>./result/share/doc/nixpkgs/manual.html</filename>. </para> </chapter> |