summary refs log tree commit diff
path: root/doc/stdenv
diff options
context:
space:
mode:
authorSandro <sandro.jaeckel@gmail.com>2021-03-03 01:27:20 +0100
committerGitHub <noreply@github.com>2021-03-03 01:27:20 +0100
commitd83c76ef5b437d38afaff1fc2e4b221643a51946 (patch)
treee600895dc1898c25916a678491b04f1cc7bda4d2 /doc/stdenv
parent5e0827ae543faa01a7c978bc96b77139a046c580 (diff)
parent061f514462387f40ba5898086166031592384708 (diff)
downloadnixpkgs-d83c76ef5b437d38afaff1fc2e4b221643a51946.tar
nixpkgs-d83c76ef5b437d38afaff1fc2e4b221643a51946.tar.gz
nixpkgs-d83c76ef5b437d38afaff1fc2e4b221643a51946.tar.bz2
nixpkgs-d83c76ef5b437d38afaff1fc2e4b221643a51946.tar.lz
nixpkgs-d83c76ef5b437d38afaff1fc2e4b221643a51946.tar.xz
nixpkgs-d83c76ef5b437d38afaff1fc2e4b221643a51946.tar.zst
nixpkgs-d83c76ef5b437d38afaff1fc2e4b221643a51946.zip
Merge pull request #113062 from SuperSandro2000/outputs-update
doc: update multiple output section with more example paths
Diffstat (limited to 'doc/stdenv')
-rw-r--r--doc/stdenv/multiple-output.xml12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/stdenv/multiple-output.xml b/doc/stdenv/multiple-output.xml
index 20658918db7..f710a9959ad 100644
--- a/doc/stdenv/multiple-output.xml
+++ b/doc/stdenv/multiple-output.xml
@@ -154,7 +154,7 @@
      </term>
      <listitem>
       <para>
-       is for development-only files. These include C(++) headers, pkg-config, cmake and aclocal files. They go to <varname>dev</varname> or <varname>out</varname> by default.
+       is for development-only files. These include C(++) headers (<filename>include/</filename>), pkg-config (<filename>lib/pkgconfig/</filename>), cmake (<filename>lib/cmake/</filename>) and aclocal files (<varname>share/aclocal/</varname>). They go to <varname>dev</varname> or <varname>out</varname> by default.
       </para>
      </listitem>
     </varlistentry>
@@ -164,7 +164,7 @@
      </term>
      <listitem>
       <para>
-       is meant for user-facing binaries, typically residing in bin/. They go to <varname>bin</varname> or <varname>out</varname> by default.
+       is meant for user-facing binaries, typically residing in <filename>bin/</filename>. They go to <varname>bin</varname> or <varname>out</varname> by default.
       </para>
      </listitem>
     </varlistentry>
@@ -194,7 +194,7 @@
      </term>
      <listitem>
       <para>
-       is for <emphasis>developer</emphasis> documentation. Currently we count gtk-doc and devhelp books in there. It goes to <varname>devdoc</varname> or is removed (!) by default. This is because e.g. gtk-doc tends to be rather large and completely unused by nixpkgs users.
+       is for <emphasis>developer</emphasis> documentation. Currently we count gtk-doc and devhelp books, typically residing in <filename>share/gtk-doc/</filename> and <filename>share/devhelp/</filename>, in there. It goes to <varname>devdoc</varname> or is removed (!) by default. This is because e.g. gtk-doc tends to be rather large and completely unused by nixpkgs users.
       </para>
      </listitem>
     </varlistentry>
@@ -204,7 +204,7 @@
      </term>
      <listitem>
       <para>
-       is for man pages (except for section 3). They go to <varname>man</varname> or <varname>$outputBin</varname> by default.
+       is for man pages (except for section 3), typically residing in <filename>share/man/man[0-9]/</filename>. They go to <varname>man</varname> or <varname>$outputBin</varname> by default.
       </para>
      </listitem>
     </varlistentry>
@@ -214,7 +214,7 @@
      </term>
      <listitem>
       <para>
-       is for section 3 man pages. They go to <varname>devman</varname> or <varname>$outputMan</varname> by default.
+       is for section 3 man pages, typically residing in <filename>share/man/man3/</filename>. They go to <varname>devman</varname> or <varname>$outputMan</varname> by default.
       </para>
      </listitem>
     </varlistentry>
@@ -224,7 +224,7 @@
      </term>
      <listitem>
       <para>
-       is for info pages. They go to <varname>info</varname> or <varname>$outputBin</varname> by default.
+       is for info pages, typically residing in <filename>share/info/</filename>. They go to <varname>info</varname> or <varname>$outputBin</varname> by default.
       </para>
      </listitem>
     </varlistentry>