doc: re-format

1 files changed, 42 insertions, 118 deletions

diff --git a/doc/reviewing-contributions.xml b/doc/reviewing-contributions.xml
index 5aa950625ef..5a14684f9b1 100644
--- a/doc/reviewing-contributions.xml
+++ b/doc/reviewing-contributions.xml
@@ -6,68 +6,40 @@
  <title>Reviewing contributions</title>
  <warning>
   <para>
-   The following section is a draft, and the policy for reviewing is still
-   being discussed in issues such as
-   <link
-	   xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166
-   </link> and
-   <link
-	   xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836
-   </link>.
+   The following section is a draft, and the policy for reviewing is still being discussed in issues such as <link
+	   xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166 </link> and <link
+	   xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836 </link>.
   </para>
  </warning>
  <para>
-  The Nixpkgs project receives a fairly high number of contributions via GitHub
-  pull requests. Reviewing and approving these is an important task and a way
-  to contribute to the project.
+  The Nixpkgs project receives a fairly high number of contributions via GitHub pull requests. Reviewing and approving these is an important task and a way to contribute to the project.
  </para>
  <para>
-  The high change rate of Nixpkgs makes any pull request that remains open for
-  too long subject to conflicts that will require extra work from the submitter
-  or the merger. Reviewing pull requests in a timely manner and being
-  responsive to the comments is the key to avoid this issue. GitHub provides
-  sort filters that can be used to see the
-  <link
-  xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most
-  recently</link> and the
-  <link
-  xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least
-  recently</link> updated pull requests. We highly encourage looking at
-  <link xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone">
-  this list of ready to merge, unreviewed pull requests</link>.
+  The high change rate of Nixpkgs makes any pull request that remains open for too long subject to conflicts that will require extra work from the submitter or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid this issue. GitHub provides sort filters that can be used to see the <link
+  xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most recently</link> and the <link
+  xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least recently</link> updated pull requests. We highly encourage looking at <link xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone"> this list of ready to merge, unreviewed pull requests</link>.
  </para>
  <para>
-  When reviewing a pull request, please always be nice and polite.
-  Controversial changes can lead to controversial opinions, but it is important
-  to respect every community member and their work.
+  When reviewing a pull request, please always be nice and polite. Controversial changes can lead to controversial opinions, but it is important to respect every community member and their work.
  </para>
  <para>
-  GitHub provides reactions as a simple and quick way to provide feedback to
-  pull requests or any comments. The thumb-down reaction should be used with
-  care and if possible accompanied with some explanation so the submitter has
-  directions to improve their contribution.
+  GitHub provides reactions as a simple and quick way to provide feedback to pull requests or any comments. The thumb-down reaction should be used with care and if possible accompanied with some explanation so the submitter has directions to improve their contribution.
  </para>
  <para>
-  pull request reviews should include a list of what has been reviewed in a
-  comment, so other reviewers and mergers can know the state of the review.
+  pull request reviews should include a list of what has been reviewed in a comment, so other reviewers and mergers can know the state of the review.
  </para>
  <para>
-  All the review template samples provided in this section are generic and
-  meant as examples. Their usage is optional and the reviewer is free to adapt
-  them to their liking.
+  All the review template samples provided in this section are generic and meant as examples. Their usage is optional and the reviewer is free to adapt them to their liking.
  </para>
  <section xml:id="reviewing-contributions-package-updates">
   <title>Package updates</title>
 
   <para>
-   A package update is the most trivial and common type of pull request. These
-   pull requests mainly consist of updating the version part of the package
-   name and the source hash.
+   A package update is the most trivial and common type of pull request. These pull requests mainly consist of updating the version part of the package name and the source hash.
   </para>
 
   <para>
-   It can happen that non-trivial updates include patches or more complex
-   changes.
+   It can happen that non-trivial updates include patches or more complex changes.
   </para>
 
   <para>
@@ -82,8 +54,7 @@
     <itemizedlist>
      <listitem>
       <para>
-       <literal>8.has: package (update)</literal> and any topic label that fit
-       the updated package.
+       <literal>8.has: package (update)</literal> and any topic label that fit the updated package.
       </para>
      </listitem>
     </itemizedlist>
@@ -105,9 +76,7 @@
     <itemizedlist>
      <listitem>
       <para>
-       <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link>
-       will make GitHub notify users based on the submitted changes, but it can
-       happen that it misses some of the package maintainers.
+       <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link> will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers.
       </para>
      </listitem>
     </itemizedlist>
@@ -119,15 +88,12 @@
     <itemizedlist>
      <listitem>
       <para>
-       License can change with version updates, so it should be checked to
-       match the upstream license.
+       License can change with version updates, so it should be checked to match the upstream license.
       </para>
      </listitem>
      <listitem>
       <para>
-       If the package has no maintainer, a maintainer must be set. This can be
-       the update submitter or a community member that accepts to take
-       maintainership of the package.
+       If the package has no maintainer, a maintainer must be set. This can be the update submitter or a community member that accepts to take maintainership of the package.
       </para>
      </listitem>
     </itemizedlist>
@@ -144,14 +110,10 @@
     <itemizedlist>
      <listitem>
       <para>
-       pull requests are often targeted to the master or staging branch, and
-       building the pull request locally when it is submitted can trigger many
-       source builds.
+       pull requests are often targeted to the master or staging branch, and building the pull request locally when it is submitted can trigger many source builds.
       </para>
       <para>
-       It is possible to rebase the changes on nixos-unstable or
-       nixpkgs-unstable for easier review by running the following commands
-       from a nixpkgs clone.
+       It is possible to rebase the changes on nixos-unstable or nixpkgs-unstable for easier review by running the following commands from a nixpkgs clone.
 <screen>
 <prompt>$ </prompt>git remote add channels https://github.com/NixOS/nixpkgs-channels.git <co
   xml:id='reviewing-rebase-1' />
@@ -163,8 +125,7 @@
        <calloutlist>
         <callout arearefs='reviewing-rebase-1'>
          <para>
-          This should be done only once to be able to fetch channel branches
-          from the nixpkgs-channels repository.
+          This should be done only once to be able to fetch channel branches from the nixpkgs-channels repository.
          </para>
         </callout>
         <callout arearefs='reviewing-rebase-2'>
@@ -174,9 +135,7 @@
         </callout>
         <callout arearefs='reviewing-rebase-3'>
          <para>
-          Fetching the pull request changes, <varname>PRNUMBER</varname> is the
-          number at the end of the pull request title and
-          <varname>BASEBRANCH</varname> the base branch of the pull request.
+          Fetching the pull request changes, <varname>PRNUMBER</varname> is the number at the end of the pull request title and <varname>BASEBRANCH</varname> the base branch of the pull request.
          </para>
         </callout>
         <callout arearefs='reviewing-rebase-4'>
@@ -189,12 +148,7 @@
      </listitem>
      <listitem>
       <para>
-       The
-       <link xlink:href="https://github.com/Mic92/nix-review">nix-review</link>
-       tool can be used to review a pull request content in a single command.
-       <varname>PRNUMBER</varname> should be replaced by the number at the end
-       of the pull request title. You can also provide the full github pull
-       request url.
+       The <link xlink:href="https://github.com/Mic92/nix-review">nix-review</link> tool can be used to review a pull request content in a single command. <varname>PRNUMBER</varname> should be replaced by the number at the end of the pull request title. You can also provide the full github pull request url.
       </para>
 <screen>
 <prompt>$ </prompt>nix-shell -p nix-review --run "nix-review pr PRNUMBER"
@@ -231,8 +185,7 @@
   <title>New packages</title>
 
   <para>
-   New packages are a common type of pull requests. These pull requests
-   consists in adding a new nix-expression for a package.
+   New packages are a common type of pull requests. These pull requests consists in adding a new nix-expression for a package.
   </para>
 
   <para>
@@ -247,8 +200,7 @@
     <itemizedlist>
      <listitem>
       <para>
-       <literal>8.has: package (new)</literal> and any topic label that fit the
-       new package.
+       <literal>8.has: package (new)</literal> and any topic label that fit the new package.
       </para>
      </listitem>
     </itemizedlist>
@@ -280,8 +232,7 @@
      </listitem>
      <listitem>
       <para>
-       A maintainer must be set. This can be the package submitter or a
-       community member that accepts to take maintainership of the package.
+       A maintainer must be set. This can be the package submitter or a community member that accepts to take maintainership of the package.
       </para>
      </listitem>
     </itemizedlist>
@@ -303,8 +254,7 @@
      </listitem>
      <listitem>
       <para>
-       The most appropriate function should be used (e.g. packages from GitHub
-       should use <literal>fetchFromGitHub</literal>).
+       The most appropriate function should be used (e.g. packages from GitHub should use <literal>fetchFromGitHub</literal>).
       </para>
      </listitem>
     </itemizedlist>
@@ -351,8 +301,7 @@
   <title>Module updates</title>
 
   <para>
-   Module updates are submissions changing modules in some ways. These often
-   contains changes to the options or introduce new options.
+   Module updates are submissions changing modules in some ways. These often contains changes to the options or introduce new options.
   </para>
 
   <para>
@@ -367,8 +316,7 @@
     <itemizedlist>
      <listitem>
       <para>
-       <literal>8.has: module (update)</literal> and any topic label that fit
-       the module.
+       <literal>8.has: module (update)</literal> and any topic label that fit the module.
       </para>
      </listitem>
     </itemizedlist>
@@ -380,9 +328,7 @@
     <itemizedlist>
      <listitem>
       <para>
-       <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link>
-       will make GitHub notify users based on the submitted changes, but it can
-       happen that it misses some of the package maintainers.
+       <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link> will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers.
       </para>
      </listitem>
     </itemizedlist>
@@ -399,9 +345,7 @@
     <itemizedlist>
      <listitem>
       <para>
-       Type should be appropriate (string related types differs in their
-       merging capabilities, <literal>optionSet</literal> and
-       <literal>string</literal> types are deprecated).
+       Type should be appropriate (string related types differs in their merging capabilities, <literal>optionSet</literal> and <literal>string</literal> types are deprecated).
       </para>
      </listitem>
      <listitem>
@@ -418,23 +362,19 @@
     <itemizedlist>
      <listitem>
       <para>
-       <literal>mkRenamedOptionModule</literal> and
-       <literal>mkAliasOptionModule</literal> functions provide way to make
-       option changes backward compatible.
+       <literal>mkRenamedOptionModule</literal> and <literal>mkAliasOptionModule</literal> functions provide way to make option changes backward compatible.
       </para>
      </listitem>
     </itemizedlist>
    </listitem>
    <listitem>
     <para>
-     Ensure that removed options are declared with
-     <literal>mkRemovedOptionModule</literal>
+     Ensure that removed options are declared with <literal>mkRemovedOptionModule</literal>
     </para>
    </listitem>
    <listitem>
     <para>
-     Ensure that changes that are not backward compatible are mentioned in
-     release notes.
+     Ensure that changes that are not backward compatible are mentioned in release notes.
     </para>
    </listitem>
    <listitem>
@@ -480,8 +420,7 @@
     <itemizedlist>
      <listitem>
       <para>
-       <literal>8.has: module (new)</literal> and any topic label that fit the
-       module.
+       <literal>8.has: module (new)</literal> and any topic label that fit the module.
       </para>
      </listitem>
     </itemizedlist>
@@ -498,9 +437,7 @@
     <itemizedlist>
      <listitem>
       <para>
-       Type should be appropriate (string related types differs in their
-       merging capabilities, <literal>optionSet</literal> and
-       <literal>string</literal> types are deprecated).
+       Type should be appropriate (string related types differs in their merging capabilities, <literal>optionSet</literal> and <literal>string</literal> types are deprecated).
       </para>
      </listitem>
      <listitem>
@@ -522,8 +459,7 @@
      </listitem>
      <listitem>
       <para>
-       Module documentation should be declared with
-       <literal>meta.doc</literal>.
+       Module documentation should be declared with <literal>meta.doc</literal>.
       </para>
      </listitem>
     </itemizedlist>
@@ -535,8 +471,7 @@
     <itemizedlist>
      <listitem>
       <para>
-       For example, enabling a module should not open firewall ports by
-       default.
+       For example, enabling a module should not open firewall ports by default.
       </para>
      </listitem>
     </itemizedlist>
@@ -573,25 +508,18 @@
   </para>
 
   <para>
-   If you consider having enough knowledge and experience in a topic and would
-   like to be a long-term reviewer for related submissions, please contact the
-   current reviewers for that topic. They will give you information about the
-   reviewing process. The main reviewers for a topic can be hard to find as
-   there is no list, but checking past pull requests to see who reviewed or
-   git-blaming the code to see who committed to that topic can give some hints.
+   If you consider having enough knowledge and experience in a topic and would like to be a long-term reviewer for related submissions, please contact the current reviewers for that topic. They will give you information about the reviewing process. The main reviewers for a topic can be hard to find as there is no list, but checking past pull requests to see who reviewed or git-blaming the code to see who committed to that topic can give some hints.
   </para>
 
   <para>
-   Container system, boot system and library changes are some examples of the
-   pull requests fitting this category.
+   Container system, boot system and library changes are some examples of the pull requests fitting this category.
   </para>
  </section>
  <section xml:id="reviewing-contributions--merging-pull-requests">
   <title>Merging pull requests</title>
 
   <para>
-   It is possible for community members that have enough knowledge and
-   experience on a special topic to contribute by merging pull requests.
+   It is possible for community members that have enough knowledge and experience on a special topic to contribute by merging pull requests.
   </para>
 
   <para>
@@ -608,12 +536,8 @@ policy.
 -->
 
   <para>
-   In a case a contributor definitively leaves the Nix community, they should
-   create an issue or post on
-   <link
-   xlink:href="https://discourse.nixos.org">Discourse</link> with
-   references of packages and modules they maintain so the maintainership can
-   be taken over by other contributors.
+   In a case a contributor definitively leaves the Nix community, they should create an issue or post on <link
+   xlink:href="https://discourse.nixos.org">Discourse</link> with references of packages and modules they maintain so the maintainership can be taken over by other contributors.
   </para>
  </section>
 </chapter>