summary refs log tree commit diff
path: root/doc/coding-conventions.xml
diff options
context:
space:
mode:
authorSamuel Dionne-Riel <samuel@dionne-riel.com>2018-05-31 21:03:37 -0400
committerSamuel Dionne-Riel <samuel@dionne-riel.com>2018-05-31 21:03:37 -0400
commita45edd9024b8fdbe1ace26d7bd8e39370e96ae52 (patch)
tree7792ca05d588c921865dc29c41092f04579f3f94 /doc/coding-conventions.xml
parentbc0421c4cf18c431ece8d6a19f723159316f55ff (diff)
downloadnixlib-a45edd9024b8fdbe1ace26d7bd8e39370e96ae52.tar
nixlib-a45edd9024b8fdbe1ace26d7bd8e39370e96ae52.tar.gz
nixlib-a45edd9024b8fdbe1ace26d7bd8e39370e96ae52.tar.bz2
nixlib-a45edd9024b8fdbe1ace26d7bd8e39370e96ae52.tar.lz
nixlib-a45edd9024b8fdbe1ace26d7bd8e39370e96ae52.tar.xz
nixlib-a45edd9024b8fdbe1ace26d7bd8e39370e96ae52.tar.zst
nixlib-a45edd9024b8fdbe1ace26d7bd8e39370e96ae52.zip
doc: ran `make format`
With visual inspection that nothing got worse.
Diffstat (limited to 'doc/coding-conventions.xml')
-rw-r--r--doc/coding-conventions.xml168
1 files changed, 123 insertions, 45 deletions
diff --git a/doc/coding-conventions.xml b/doc/coding-conventions.xml
index f244c11d4f20..b3f7f093835c 100644
--- a/doc/coding-conventions.xml
+++ b/doc/coding-conventions.xml
@@ -312,11 +312,15 @@ args.stdenv.mkDerivation (args // {
 
    <variablelist>
     <varlistentry>
-     <term>If it’s used to support <emphasis>software development</emphasis>:</term>
+     <term>
+      If it’s used to support <emphasis>software development</emphasis>:
+     </term>
      <listitem>
       <variablelist>
        <varlistentry>
-        <term>If it’s a <emphasis>library</emphasis> used by other packages:</term>
+        <term>
+         If it’s a <emphasis>library</emphasis> used by other packages:
+        </term>
         <listitem>
          <para>
           <filename>development/libraries</filename> (e.g.
@@ -325,7 +329,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s a <emphasis>compiler</emphasis>:</term>
+        <term>
+         If it’s a <emphasis>compiler</emphasis>:
+        </term>
         <listitem>
          <para>
           <filename>development/compilers</filename> (e.g.
@@ -334,7 +340,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s an <emphasis>interpreter</emphasis>:</term>
+        <term>
+         If it’s an <emphasis>interpreter</emphasis>:
+        </term>
         <listitem>
          <para>
           <filename>development/interpreters</filename> (e.g.
@@ -343,11 +351,15 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s a (set of) development <emphasis>tool(s)</emphasis>:</term>
+        <term>
+         If it’s a (set of) development <emphasis>tool(s)</emphasis>:
+        </term>
         <listitem>
          <variablelist>
           <varlistentry>
-           <term>If it’s a <emphasis>parser generator</emphasis> (including lexers):</term>
+           <term>
+            If it’s a <emphasis>parser generator</emphasis> (including lexers):
+           </term>
            <listitem>
             <para>
              <filename>development/tools/parsing</filename> (e.g.
@@ -356,7 +368,9 @@ args.stdenv.mkDerivation (args // {
            </listitem>
           </varlistentry>
           <varlistentry>
-           <term>If it’s a <emphasis>build manager</emphasis>:</term>
+           <term>
+            If it’s a <emphasis>build manager</emphasis>:
+           </term>
            <listitem>
             <para>
              <filename>development/tools/build-managers</filename> (e.g.
@@ -365,7 +379,9 @@ args.stdenv.mkDerivation (args // {
            </listitem>
           </varlistentry>
           <varlistentry>
-           <term>Else:</term>
+           <term>
+            Else:
+           </term>
            <listitem>
             <para>
              <filename>development/tools/misc</filename> (e.g.
@@ -377,7 +393,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>Else:</term>
+        <term>
+         Else:
+        </term>
         <listitem>
          <para>
           <filename>development/misc</filename>
@@ -388,7 +406,9 @@ args.stdenv.mkDerivation (args // {
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term>If it’s a (set of) <emphasis>tool(s)</emphasis>:</term>
+     <term>
+      If it’s a (set of) <emphasis>tool(s)</emphasis>:
+     </term>
      <listitem>
       <para>
        (A tool is a relatively small program, especially one intended to be
@@ -396,7 +416,9 @@ args.stdenv.mkDerivation (args // {
       </para>
       <variablelist>
        <varlistentry>
-        <term>If it’s for <emphasis>networking</emphasis>:</term>
+        <term>
+         If it’s for <emphasis>networking</emphasis>:
+        </term>
         <listitem>
          <para>
           <filename>tools/networking</filename> (e.g.
@@ -405,7 +427,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s for <emphasis>text processing</emphasis>:</term>
+        <term>
+         If it’s for <emphasis>text processing</emphasis>:
+        </term>
         <listitem>
          <para>
           <filename>tools/text</filename> (e.g. <filename>diffutils</filename>)
@@ -413,9 +437,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s a <emphasis>system utility</emphasis>, i.e.,
-          something related or essential to the operation of a
-          system:</term>
+        <term>
+         If it’s a <emphasis>system utility</emphasis>, i.e., something related or essential to the operation of a system:
+        </term>
         <listitem>
          <para>
           <filename>tools/system</filename> (e.g. <filename>cron</filename>)
@@ -423,8 +447,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s an <emphasis>archiver</emphasis> (which may
-          include a compression function):</term>
+        <term>
+         If it’s an <emphasis>archiver</emphasis> (which may include a compression function):
+        </term>
         <listitem>
          <para>
           <filename>tools/archivers</filename> (e.g. <filename>zip</filename>,
@@ -433,7 +458,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s a <emphasis>compression</emphasis> program:</term>
+        <term>
+         If it’s a <emphasis>compression</emphasis> program:
+        </term>
         <listitem>
          <para>
           <filename>tools/compression</filename> (e.g.
@@ -442,7 +469,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s a <emphasis>security</emphasis>-related program:</term>
+        <term>
+         If it’s a <emphasis>security</emphasis>-related program:
+        </term>
         <listitem>
          <para>
           <filename>tools/security</filename> (e.g. <filename>nmap</filename>,
@@ -451,7 +480,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>Else:</term>
+        <term>
+         Else:
+        </term>
         <listitem>
          <para>
           <filename>tools/misc</filename>
@@ -462,7 +493,9 @@ args.stdenv.mkDerivation (args // {
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term>If it’s a <emphasis>shell</emphasis>:</term>
+     <term>
+      If it’s a <emphasis>shell</emphasis>:
+     </term>
      <listitem>
       <para>
        <filename>shells</filename> (e.g. <filename>bash</filename>)
@@ -470,11 +503,15 @@ args.stdenv.mkDerivation (args // {
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term>If it’s a <emphasis>server</emphasis>:</term>
+     <term>
+      If it’s a <emphasis>server</emphasis>:
+     </term>
      <listitem>
       <variablelist>
        <varlistentry>
-        <term>If it’s a web server:</term>
+        <term>
+         If it’s a web server:
+        </term>
         <listitem>
          <para>
           <filename>servers/http</filename> (e.g.
@@ -483,7 +520,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s an implementation of the X Windowing System:</term>
+        <term>
+         If it’s an implementation of the X Windowing System:
+        </term>
         <listitem>
          <para>
           <filename>servers/x11</filename> (e.g. <filename>xorg</filename> —
@@ -492,7 +531,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>Else:</term>
+        <term>
+         Else:
+        </term>
         <listitem>
          <para>
           <filename>servers/misc</filename>
@@ -503,7 +544,9 @@ args.stdenv.mkDerivation (args // {
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term>If it’s a <emphasis>desktop environment</emphasis>:</term>
+     <term>
+      If it’s a <emphasis>desktop environment</emphasis>:
+     </term>
      <listitem>
       <para>
        <filename>desktops</filename> (e.g. <filename>kde</filename>,
@@ -512,7 +555,9 @@ args.stdenv.mkDerivation (args // {
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term>If it’s a <emphasis>window manager</emphasis>:</term>
+     <term>
+      If it’s a <emphasis>window manager</emphasis>:
+     </term>
      <listitem>
       <para>
        <filename>applications/window-managers</filename> (e.g.
@@ -521,7 +566,9 @@ args.stdenv.mkDerivation (args // {
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term>If it’s an <emphasis>application</emphasis>:</term>
+     <term>
+      If it’s an <emphasis>application</emphasis>:
+     </term>
      <listitem>
       <para>
        A (typically large) program with a distinct user interface, primarily
@@ -529,7 +576,9 @@ args.stdenv.mkDerivation (args // {
       </para>
       <variablelist>
        <varlistentry>
-        <term>If it’s a <emphasis>version management system</emphasis>:</term>
+        <term>
+         If it’s a <emphasis>version management system</emphasis>:
+        </term>
         <listitem>
          <para>
           <filename>applications/version-management</filename> (e.g.
@@ -538,7 +587,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s for <emphasis>video playback / editing</emphasis>:</term>
+        <term>
+         If it’s for <emphasis>video playback / editing</emphasis>:
+        </term>
         <listitem>
          <para>
           <filename>applications/video</filename> (e.g.
@@ -547,7 +598,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s for <emphasis>graphics viewing / editing</emphasis>:</term>
+        <term>
+         If it’s for <emphasis>graphics viewing / editing</emphasis>:
+        </term>
         <listitem>
          <para>
           <filename>applications/graphics</filename> (e.g.
@@ -556,11 +609,15 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s for <emphasis>networking</emphasis>:</term>
+        <term>
+         If it’s for <emphasis>networking</emphasis>:
+        </term>
         <listitem>
          <variablelist>
           <varlistentry>
-           <term>If it’s a <emphasis>mailreader</emphasis>:</term>
+           <term>
+            If it’s a <emphasis>mailreader</emphasis>:
+           </term>
            <listitem>
             <para>
              <filename>applications/networking/mailreaders</filename> (e.g.
@@ -569,7 +626,9 @@ args.stdenv.mkDerivation (args // {
            </listitem>
           </varlistentry>
           <varlistentry>
-           <term>If it’s a <emphasis>newsreader</emphasis>:</term>
+           <term>
+            If it’s a <emphasis>newsreader</emphasis>:
+           </term>
            <listitem>
             <para>
              <filename>applications/networking/newsreaders</filename> (e.g.
@@ -578,7 +637,9 @@ args.stdenv.mkDerivation (args // {
            </listitem>
           </varlistentry>
           <varlistentry>
-           <term>If it’s a <emphasis>web browser</emphasis>:</term>
+           <term>
+            If it’s a <emphasis>web browser</emphasis>:
+           </term>
            <listitem>
             <para>
              <filename>applications/networking/browsers</filename> (e.g.
@@ -587,7 +648,9 @@ args.stdenv.mkDerivation (args // {
            </listitem>
           </varlistentry>
           <varlistentry>
-           <term>Else:</term>
+           <term>
+            Else:
+           </term>
            <listitem>
             <para>
              <filename>applications/networking/misc</filename>
@@ -598,7 +661,9 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>Else:</term>
+        <term>
+         Else:
+        </term>
         <listitem>
          <para>
           <filename>applications/misc</filename>
@@ -609,12 +674,15 @@ args.stdenv.mkDerivation (args // {
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term>If it’s <emphasis>data</emphasis> (i.e., does not have a
-    straight-forward executable semantics):</term>
+     <term>
+      If it’s <emphasis>data</emphasis> (i.e., does not have a straight-forward executable semantics):
+     </term>
      <listitem>
       <variablelist>
        <varlistentry>
-        <term>If it’s a <emphasis>font</emphasis>:</term>
+        <term>
+         If it’s a <emphasis>font</emphasis>:
+        </term>
         <listitem>
          <para>
           <filename>data/fonts</filename>
@@ -622,11 +690,15 @@ args.stdenv.mkDerivation (args // {
         </listitem>
        </varlistentry>
        <varlistentry>
-        <term>If it’s related to <emphasis>SGML/XML processing</emphasis>:</term>
+        <term>
+         If it’s related to <emphasis>SGML/XML processing</emphasis>:
+        </term>
         <listitem>
          <variablelist>
           <varlistentry>
-           <term>If it’s an <emphasis>XML DTD</emphasis>:</term>
+           <term>
+            If it’s an <emphasis>XML DTD</emphasis>:
+           </term>
            <listitem>
             <para>
              <filename>data/sgml+xml/schemas/xml-dtd</filename> (e.g.
@@ -635,7 +707,9 @@ args.stdenv.mkDerivation (args // {
            </listitem>
           </varlistentry>
           <varlistentry>
-           <term>If it’s an <emphasis>XSLT stylesheet</emphasis>:</term>
+           <term>
+            If it’s an <emphasis>XSLT stylesheet</emphasis>:
+           </term>
            <listitem>
             <para>
              (Okay, these are executable...)
@@ -653,7 +727,9 @@ args.stdenv.mkDerivation (args // {
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term>If it’s a <emphasis>game</emphasis>:</term>
+     <term>
+      If it’s a <emphasis>game</emphasis>:
+     </term>
      <listitem>
       <para>
        <filename>games</filename>
@@ -661,7 +737,9 @@ args.stdenv.mkDerivation (args // {
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term>Else:</term>
+     <term>
+      Else:
+     </term>
      <listitem>
       <para>
        <filename>misc</filename>