linux-from-scratch/glfs
1
0
Fork 0
mirror of https://github.com/Zeckmathederg/glfs.git synced 2025-02-02 22:07:15 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarified comments in "template.xml".

Browse Source
This commit is contained in:
David Bryant 2022-10-29 17:44:36 -05:00
parent 395cf7d04a
commit 6fe407f4e2
1 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
template/template.xml
View File

@ -14,11 +14,11 @@
<!ENTITY TEMPLATE-size "?? MB">
<!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. -->
]>
@ -34,7 +34,10 @@
</sect1info>
<!-- 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>
<indexterm zone="TEMPLATE">
@ -111,7 +114,7 @@
"and"). BLFS_DEPENDENCY should be an "id" attribute defined somewhere
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>
@ -141,8 +144,8 @@
<xref linkend="BLFS_DEPENDENCY"/> and
<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>
@ -174,7 +177,7 @@
<para>
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>
<indexterm zone="TEMPLATE TEMPLATE-kernel">
@ -197,7 +200,7 @@ make</userinput></screen>
<!-- 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
same block as configure and make. -->
@ -210,8 +213,8 @@ make</userinput></screen>
<!-- 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 -->
@ -374,7 +377,7 @@ EOF</userinput></screen>
been made to change the "None" to just removing the whole section
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. -->
<seglistitem>
@ -401,7 +404,7 @@ EOF</userinput></screen>
<?dbfo list-presentation="list"?>
<?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 -->