diff options
| author | Alyssa Ross <hi@alyssa.is> | 2019-01-07 02:18:36 +0000 |
|---|---|---|
| committer | Alyssa Ross <hi@alyssa.is> | 2019-01-07 02:18:47 +0000 |
| commit | 36f56d99fa0a0765c9f1de4a5f17a9b05830c3f2 (patch) | |
| tree | b3faaf573407b32aa645237a4d16b82778a39a92 /nixpkgs/doc/contributing.xml | |
| parent | 4e31070265257dc67d120c27e0f75c2344fdfa9a (diff) | |
| parent | abf060725d7614bd3b9f96764262dfbc2f9c2199 (diff) | |
| download | nixlib-36f56d99fa0a0765c9f1de4a5f17a9b05830c3f2.tar nixlib-36f56d99fa0a0765c9f1de4a5f17a9b05830c3f2.tar.gz nixlib-36f56d99fa0a0765c9f1de4a5f17a9b05830c3f2.tar.bz2 nixlib-36f56d99fa0a0765c9f1de4a5f17a9b05830c3f2.tar.lz nixlib-36f56d99fa0a0765c9f1de4a5f17a9b05830c3f2.tar.xz nixlib-36f56d99fa0a0765c9f1de4a5f17a9b05830c3f2.tar.zst nixlib-36f56d99fa0a0765c9f1de4a5f17a9b05830c3f2.zip | |
Add 'nixpkgs/' from commit 'abf060725d7614bd3b9f96764262dfbc2f9c2199'
git-subtree-dir: nixpkgs git-subtree-mainline: 4e31070265257dc67d120c27e0f75c2344fdfa9a git-subtree-split: abf060725d7614bd3b9f96764262dfbc2f9c2199
Diffstat (limited to 'nixpkgs/doc/contributing.xml')
| -rw-r--r-- | nixpkgs/doc/contributing.xml | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/nixpkgs/doc/contributing.xml b/nixpkgs/doc/contributing.xml new file mode 100644 index 000000000000..d28442b7a2c6 --- /dev/null +++ b/nixpkgs/doc/contributing.xml @@ -0,0 +1,35 @@ +<chapter xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + 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. + </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>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: +<screen> + $ 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 + <filename>./result/share/doc/nixpkgs/manual.html</filename>. + </para> +</chapter> |