Changeset 6fe407f4

Timestamp:

10/29/2022 10:44:36 PM (18 months ago)

Author:

David Bryant <davidbryant@…>

Branches:

11.3, 12.0, 12.1, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, xry111/llvm18, xry111/xf86-video-removal

Children:

4c59e83

Parents:

395cf7d

Message:

Clarified comments in "template.xml".

File:

• template/template.xml (modified) (9 diffs)

template/template.xml

@@ -15 +15 @@
   <!ENTITY TEMPLATE-buildsize     "?? MB">
   <!ENTITY TEMPLATE-time          "?? SBU">
-<!-- SBU should be rounded to integer if greater than 10, to one
-     decimal if below 10, and should be "less than 0.1 SBU" if
-     below 0.1. If the SBU without parallelisation is too long,
+<!-- SBU should be rounded to nearer integer if greater than 10, to one
+     decimal if less than 10, and should be "less than 0.1 SBU" if
+     less than 0.1. If the SBU without parallelisation is too long,
      it is acceptable to give the value "with parallelism=N", where
-     N is the number of threads used. Note that some build system
+     N is the number of threads used. Note that some build systems
      automatically fix N equal to the number of available CPU cores
      on the machine. -->
@@ -35 +35 @@
 
   <!-- No other tags inside any title.
-       Use Title Case in All Titles -->
+       Use Title Case in All Titles 
+       (i.e., Capitalize Everything
+       *Except* Articles, Short Prepositions,
+       and Coordinating Conjunctions.-->
   <title>TEMPLATE-&TEMPLATE-version;</title>
 
@@ -112 +115 @@
       in the book (usually in a <sect1>). -->
       <xref role="runtime" linkend="RUNTIME_DEPENDENCY"/> (runtime)
-      <!-- Specifying that a dependency is a runtime one, may avoid circular
+      <!-- Specifying that a dependency is a runtime one may avoid circular
       dependencies. Add role="runtime" to help jhalfs -->
     </para>
@@ -142 +145 @@
       <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>
       <!-- notice no period as this is not a sentence. See above for the use
-      of commas and "and". The order should <xref> before <ulink>.-->
-      <!-- See above how to refer to another package, which is not a
+      of commas and "and". The order should be <xref> before <ulink>.-->
+      <!-- See above for references to another package which is not a
       dependency. -->
     </para>
@@ -175 +178 @@
       Select the appropriate sub-options that appear when the above options are
       selected. As much as possible, the layout should be the same as in
-      kernel menus.
+      kernel configuration menus.
     </para>
 
@@ -198 +201 @@
     <!-- Optional paragraph. Add it when some instructions for building
          documentation need optional or external packages. The remap="doc"
-         attribute signals those kind of instructions. Note: instructions
+         attribute signals that kind of instructions. Note: instructions
          for generating documentation that can be built with
          recommended/required/LFS book packages may be included in the
@@ -211 +214 @@
     <!-- adjust the instructions as needed. -->
 
-    <!-- Optional paragraph. Use one of the two mentions below about a test
-         suite, delete the line that is not applicable. Of course, if the
+    <!-- Optional paragraph. Use one of the two formats below about the test
+         suite; delete the line that is not applicable. Of course, if the
          test suite uses syntax other than 'make check', revise the
          line to reflect the actual syntax to run the test suite -->
@@ -375 +378 @@
            because I've noticed that many packages have had the "None"
            removed and the section completely removed as well. The reasoning
-           was that by putting "None", it appears as we know there are none.
+           was that by putting "None", it appears as if we know there are none.
            Without anything it appears as we are not sure. -->
 
@@ -402 +405 @@
       <?dbhtml list-presentation="table"?>
 
-      <!-- If the program or library name conflicts (is the same) as the
+      <!-- If the program or library name conflicts with (is the same as) the
       package name, add -prog or -lib to the varlistentry entity id
       and the 2nd entry of the indexterm zone entity -->