Merge pull request #45914 from grahamc/section-ids

Section ids

doc/cross-compilation.xml

@@ -30,7 +30,7 @@
  <section xml:id="sec-cross-packaging">
   <title>Packaging in a cross-friendly manner</title>
 
-  <section>
+  <section xml:id="sec-cross-platform-parameters">
    <title>Platform parameters</title>
 
    <para>
@@ -219,7 +219,7 @@
    </variablelist>
   </section>
 
-  <section>
+  <section xml:id="sec-cross-specifying-dependencies">
    <title>Specifying Dependencies</title>
 
    <para>
@@ -304,7 +304,7 @@
    </note>
   </section>
 
-  <section>
+  <section xml:id="sec-cross-cookbook">
    <title>Cross packaging cookbook</title>
 
    <para>
@@ -317,7 +317,7 @@
    </para>
 
    <qandaset>
-    <qandaentry>
+    <qandaentry xml:id="cross-qa-build-c-program-in-build-environment">
      <question>
       <para>
        What if my package's build system needs to build a C program to be run
@@ -331,7 +331,7 @@
       </para>
      </answer>
     </qandaentry>
-    <qandaentry>
+    <qandaentry xml:id="cross-qa-fails-to-find-ar">
      <question>
       <para>
        My package fails to find <command>ar</command>.
@@ -347,7 +347,7 @@
       </para>
      </answer>
     </qandaentry>
-    <qandaentry>
+    <qandaentry xml:id="cross-testsuite-runs-host-code">
      <question>
       <para>
        My package's testsuite needs to run host platform code.

doc/languages-frameworks/texlive.xml

@@ -8,7 +8,7 @@
   under attribute <varname>texlive</varname>.
  </para>
 
- <section>
+ <section xml:id="sec-language-texlive-users-guide">
   <title>User's guide</title>
 
   <itemizedlist>
@@ -68,7 +68,7 @@ nix-repl> texlive.collection-&lt;TAB>
   </itemizedlist>
  </section>
 
- <section>
+ <section xml:id="sec-language-texlive-known-problems">
   <title>Known problems</title>
 
   <itemizedlist>

doc/multiple-output.xml

@@ -6,7 +6,7 @@
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-multiple-output">
  <title>Multiple-output packages</title>
- <section>
+ <section xml:id="sec-multiple-outputs-introduction">
   <title>Introduction</title>
 
   <para>
@@ -38,7 +38,7 @@
    </para>
   </note>
  </section>
- <section>
+ <section xml:id="sec-multiple-outputs-installing">
   <title>Installing a split package</title>
 
   <para>
@@ -84,7 +84,7 @@
    </listitem>
   </itemizedlist>
  </section>
- <section>
+ <section xml:id="sec-multiple-outputs-using-split-packages">
   <title>Using a split package</title>
 
   <para>
@@ -102,7 +102,7 @@
    also added. (See <xref linkend="multiple-output-file-type-groups" />.)
   </para>
  </section>
- <section>
+ <section xml:id="sec-multiple-outputs-">
   <title>Writing a split derivation</title>
 
   <para>
@@ -283,7 +283,7 @@
    </variablelist>
   </section>
 
-  <section>
+  <section xml:id="sec-multiple-outputs-caveats">
    <title>Common caveats</title>
 
    <itemizedlist>

doc/package-notes.xml

@@ -181,7 +181,7 @@ $ cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \
  </section>
 <!--============================================================-->
 <!--
-<section>
+<section xml:id="sec-package-notes-gnome">
   <title>Gnome</title>
   <para>* Expression is auto-generated</para>
   <para>* How to update</para>
@@ -189,7 +189,7 @@ $ cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \
 -->
 <!--============================================================-->
 <!--
-<section>
+<section xml:id="sec-package-notes-gcc">
   <title>GCC</title>
   <para>…</para>
 </section>

doc/release-notes.xml

@@ -2,7 +2,7 @@
 <article xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink">
  <title>Nixpkgs Release Notes</title>
- <section>
+ <section xml:id="release-notes-0.14">
   <title>Release 0.14 (June 4, 2012)</title>
 
   <para>
@@ -17,7 +17,7 @@
    packages by numerous contributors. For details, see the commit logs.
   </para>
  </section>
- <section>
+ <section xml:id="release-notes-0.13">
   <title>Release 0.13 (February 5, 2010)</title>
 
   <para>
@@ -51,7 +51,7 @@
    </itemizedlist>
   </para>
  </section>
- <section>
+ <section xml:id="release-notes-0.12">
   <title>Release 0.12 (April 24, 2009)</title>
 
   <para>
@@ -145,7 +145,7 @@
    <literal>nix-dev</literal> mailing list.
   </para>
  </section>
- <section>
+ <section xml:id="release-notes-0.11">
   <title>Release 0.11 (September 11, 2007)</title>
 
   <para>
@@ -344,7 +344,7 @@ export NIX_MIRRORS_sourceforge=http://osdn.dl.sourceforge.net/sourceforge/</prog
    Bravenboer, Michael Raskin, Wouter den Breejen and Yury G. Kudryashov.
   </para>
  </section>
- <section>
+ <section xml:id="release-notes-0.10">
   <title>Release 0.10 (October 12, 2006)</title>
 
   <note>
@@ -547,7 +547,7 @@ stdenv.mkDerivation {
    Bravenboer, Merijn de Jonge, Rob Vermaas and Roy van den Broek.
   </para>
  </section>
- <section>
+ <section xml:id="release-notes-0.9">
   <title>Release 0.9 (January 31, 2006)</title>
 
   <para>
@@ -676,7 +676,7 @@ stdenv.mkDerivation {
    Martin Bravenboer, Rob Vermaas and Roy van den Broek.
   </para>
  </section>
- <section>
+ <section xml:id="release-notes-0.8">
   <title>Release 0.8 (April 11, 2005)</title>
 
   <para>
@@ -700,7 +700,7 @@ stdenv.mkDerivation {
    </itemizedlist>
   </para>
  </section>
- <section>
+ <section xml:id="release-notes-0.7">
   <title>Release 0.7 (March 14, 2005)</title>
 
   <itemizedlist>

doc/reviewing-contributions.xml

@@ -56,7 +56,7 @@
   meant as examples. Their usage is optional and the reviewer is free to adapt
   them to their liking.
  </para>
- <section>
+ <section xml:id="reviewing-contributions-package-updates">
   <title>Package updates</title>
 
   <para>
@@ -208,7 +208,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
    </listitem>
   </itemizedlist>
 
-  <example>
+  <example xml:id="reviewing-contributions-sample-package-update">
    <title>Sample template for a package update review</title>
 <screen>
 ##### Reviewed points
@@ -226,7 +226,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 </screen>
   </example>
  </section>
- <section>
+ <section xml:id="reviewing-contributions-new-packages">
   <title>New packages</title>
 
   <para>
@@ -320,7 +320,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
    </listitem>
   </itemizedlist>
 
-  <example>
+  <example xml:id="reviewing-contributions-sample-new-package">
    <title>Sample template for a new package review</title>
 <screen>
 ##### Reviewed points
@@ -346,7 +346,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 </screen>
   </example>
  </section>
- <section>
+ <section xml:id="reviewing-contributions-module-updates">
   <title>Module updates</title>
 
   <para>
@@ -443,7 +443,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
    </listitem>
   </itemizedlist>
 
-  <example>
+  <example xml:id="reviewing-contributions-sample-module-update">
    <title>Sample template for a module update review</title>
 <screen>
 ##### Reviewed points
@@ -464,7 +464,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 </screen>
   </example>
  </section>
- <section>
+ <section xml:id="reviewing-contributions-new-modules">
   <title>New modules</title>
 
   <para>
@@ -542,7 +542,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
    </listitem>
   </itemizedlist>
 
-  <example>
+  <example xml:id="reviewing-contributions-sample-new-module">
    <title>Sample template for a new module review</title>
 <screen>
 ##### Reviewed points
@@ -564,7 +564,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 </screen>
   </example>
  </section>
- <section>
+ <section xml:id="reviewing-contributions-other-submissions">
   <title>Other submissions</title>
 
   <para>
@@ -585,7 +585,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
    pull requests fitting this category.
   </para>
  </section>
- <section>
+ <section xml:id="reviewing-contributions--merging-pull-requests">
   <title>Merging pull-requests</title>
 
   <para>

doc/stdenv.xml

@@ -212,7 +212,7 @@ genericBuild
    platforms relative to the new derivation's, and whether they are propagated.
    The platform distinctions are motivated by cross compilation; see
    <xref linkend="chap-cross"/> for exactly what each platform means.
-   <footnote>
+   <footnote xml:id="footnote-stdenv-ignored-build-platform">
     <para>
      The build platform is ignored because it is a mere implementation detail
      of the package satisfying the dependency: As a general programming
@@ -233,7 +233,7 @@ genericBuild
    out only for dependencies whose host platform matches the new derivation's
    build platform–i.e. which run on the platform where the new derivation
    will be built.
-   <footnote>
+   <footnote xml:id="footnote-stdenv-native-dependencies-in-path">
     <para>
      Currently, that means for native builds all dependencies are put on the
      <envar>PATH</envar>. But in the future that may not be the case for sake
@@ -280,7 +280,7 @@ genericBuild
    <link xlink:href="https://en.wikipedia.org/wiki/Natural_deduction">Natural
    Deduction</link> using the inference rules. This probably seems a bit
    obtuse, but so is the bash code that actually implements it!
-   <footnote>
+   <footnote xml:id="footnote-stdenv-find-inputs-location">
     <para>
      The <function>findInputs</function> function, currently residing in
      <filename>pkgs/stdenv/generic/setup.sh</filename>, implements the
@@ -1112,7 +1112,7 @@ passthru = {
        By default, the configure phase applies some special hackery to all
        files called <filename>ltmain.sh</filename> before running the configure
        script in order to improve the purity of Libtool-based packages
-       <footnote>
+       <footnote xml:id="footnote-stdenv-sys-lib-search-path">
         <para>
          It clears the
          <varname>sys_lib_<replaceable>*</replaceable>search_path</varname>
@@ -1151,7 +1151,7 @@ passthru = {
        or a subset to control exactly which platform flags are passed.
        Compilers and other tools should use this to also pass the target
        platform, for example.
-       <footnote>
+       <footnote xml:id="footnote-stdenv-build-time-guessing-impurity">
         <para>
          Eventually these will be passed when in native builds too, to improve
          determinism: build-time guessing, as is done today, is a risk of
@@ -1732,7 +1732,7 @@ set debug-file-directory ~/.nix-profile/lib/debug
        Controls whether the installCheck phase is executed. By default it is
        skipped, but if <varname>doInstallCheck</varname> is set to true, the
        installCheck phase is usually executed. Thus you should set
-       <programlisting>doInstallCheck = true;</programlisting>
+<programlisting>doInstallCheck = true;</programlisting>
        in the derivation to enable install checks. The exception is cross
        compilation. Cross compiled builds never run tests, no matter how
        <varname>doInstallCheck</varname> is set, as the newly-built program
@@ -2213,7 +2213,7 @@ addEnvHooks "$hostOffset" myBashFunction
        <command>clang</command> is to be used. Secondly, this helps packages
        not get confused when cross-compiling, in which case multiple Bintools
        Wrappers may simultaneously be in use.
-       <footnote>
+       <footnote xml:id="footnote-stdenv-per-platform-wrapper">
         <para>
          Each wrapper targets a single platform, so if binaries for multiple
          platforms are needed, the underlying binaries must be wrapped multiple

doc/submitting-changes.xml

@@ -2,7 +2,7 @@
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-submitting-changes">
  <title>Submitting changes</title>
- <section>
+ <section xml:id="submitting-changes-making-patches">
   <title>Making patches</title>
 
   <itemizedlist>
@@ -205,7 +205,7 @@ Additional information.
    </listitem>
   </itemizedlist>
  </section>
- <section>
+ <section xml:id="submitting-changes-submitting-changes">
   <title>Submitting changes</title>
 
   <itemizedlist>
@@ -253,7 +253,7 @@ Additional information.
    </listitem>
   </itemizedlist>
  </section>
- <section>
+ <section xml:id="submitting-changes-pull-request-template">
   <title>Pull Request Template</title>
 
   <para>
@@ -269,7 +269,7 @@ Additional information.
    below:
   </para>
 
-  <section>
+  <section xml:id="submitting-changes-tested-with-sandbox">
    <title>Tested using sandboxing</title>
 
    <para>
@@ -322,7 +322,7 @@ Additional information.
    </para>
   </section>
 
-  <section>
+  <section xml:id="submitting-changes-platform-diversity">
    <title>Built on platform(s)</title>
 
    <para>
@@ -334,7 +334,7 @@ Additional information.
    </para>
   </section>
 
-  <section>
+  <section xml:id="submitting-changes-nixos-tests">
    <title>Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)</title>
 
    <para>
@@ -350,7 +350,7 @@ Additional information.
    </para>
   </section>
 
-  <section>
+  <section xml:id="submitting-changes-tested-compilation">
    <title>Tested compilation of all pkgs that depend on this change using <command>nox-review</command></title>
 
    <para>
@@ -373,7 +373,7 @@ Additional information.
    </para>
   </section>
 
-  <section>
+  <section xml:id="submitting-changes-tested-execution">
    <title>Tested execution of all binary files (usually in <filename>./result/bin/</filename>)</title>
 
    <para>
@@ -387,8 +387,8 @@ Additional information.
    </para>
   </section>
 
-  <section>
+  <section xml:id="submitting-changes-contribution-standards">
-   <title>Meets nixpkgs contribution standards</title>
+   <title>Meets Nixpkgs contribution standards</title>
 
    <para>
     The last checkbox is fits
@@ -402,7 +402,7 @@ Additional information.
    </para>
   </section>
  </section>
- <section>
+ <section xml:id="submitting-changes-hotfixing-pull-requests">
   <title>Hotfixing pull requests</title>
 
   <itemizedlist>
@@ -430,7 +430,7 @@ Additional information.
    </listitem>
   </itemizedlist>
  </section>
- <section>
+ <section xml:id="submitting-changes-commit-policy">
   <title>Commit policy</title>
 
   <itemizedlist>
@@ -456,7 +456,7 @@ Additional information.
    </listitem>
   </itemizedlist>
 
-  <section>
+  <section xml:id="submitting-changes-master-branch">
    <title>Master branch</title>
 
    <itemizedlist>
@@ -468,7 +468,7 @@ Additional information.
    </itemizedlist>
   </section>
 
-  <section>
+  <section xml:id="submitting-changes-staging-branch">
    <title>Staging branch</title>
 
    <itemizedlist>
@@ -493,7 +493,7 @@ Additional information.
    </itemizedlist>
   </section>
 
-  <section>
+  <section xml:id="submitting-changes-stable-release-branches">
    <title>Stable release branches</title>
 
    <itemizedlist>