| Newsgroups |
gmane.linux.lfs.beyond.book |
| Message-ID |
<178224276829.436291.478638127663851556@rivendell.linuxfromscratch.org> |
This is an automated email from the git hooks/post-receive script.
git pushed a commit to branch trunk
in repository blfs.
The following commit(s) were added to refs/heads/trunk by this push:
new be829f772f Fix some naming issues. Generally on a page we want the title name to match the tarball name so capitalization becomes an issue.
be829f772f is described below
commit be829f772f174ed44e2e1afbe098758ddff0d984
Author: Bruce Dubbs <[email protected]>
AuthorDate: Tue Jun 23 14:00:30 2026 -0500
Fix some naming issues.
Generally on a page we want the title name to match the tarball name
so capitalization becomes an issue.
In the case of JSON, which is an acronym, it should be capitalized,
but the package name should be json, json-c, json-glib, etc.
Capitalization in a title can be OK. The use of
'Wayfire Dependencies' is OK, but the title should be 'wayfire-0.10.1'.
If this is not done it can confuse dependency scripts.
There are lots of inconsistencies in the book now, but a complete
review and update woulld take some time which we do not have right now.
For instance we have a title of 'FLTK-1.3.11' when the tarball name is
'fltk-1.3.11-source'. Omitting 'source' is approprite, but the title
should be lower cased. This also goes for the docbook attributes id=
and xreflabel=. Any time we use <application>package</application>,
the package name should match the tarball name.
In the case of json, I also added a parenthetical addition '(nlohmann-json)'
to the title for clarification.
In LFS the package titles are ALL capitalized so at least that is consistent.
---
general/genlib/genlib.xml | 2 +-
general/genlib/json-c.xml | 19 +++++++++----------
general/genlib/json-glib.xml | 18 +++++++++---------
general/genlib/nlohmann-json.xml | 4 ++--
x/installing/wayfire.xml | 8 ++++----
5 files changed, 25 insertions(+), 26 deletions(-)
diff --git a/general/genlib/genlib.xml b/general/genlib/genlib.xml
index 2cce08eacd..c4f89fa0f0 100644
--- a/general/genlib/genlib.xml
+++ b/general/genlib/genlib.xml
@@ -80,6 +80,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="icu.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="inih.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="jansson.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nlohmann-json.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="json-c.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="json-glib.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="keyutils.xml"/>
@@ -154,7 +155,6 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="log4cplus.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="lzo.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="mtdev.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nlohmann-json.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nodejs.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="npth.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nspr.xml"/>
diff --git a/general/genlib/json-c.xml b/general/genlib/json-c.xml
index f5c22acf71..b7533e2074 100644
--- a/general/genlib/json-c.xml
+++ b/general/genlib/json-c.xml
@@ -12,21 +12,20 @@
<!ENTITY json-c-time "0.2 SBU (with tests)">
]>
-<sect1 id="json-c" xreflabel="JSON-C-&json-c-version;">
+<sect1 id="json-c" xreflabel="json-c-&json-c-version;">
<?dbhtml filename="json-c.html"?>
-
- <title>JSON-C-&json-c-version;</title>
+ <title>json-c-&json-c-version;</title>
<indexterm zone="json-c">
- <primary sortas="a-JSON-C">JSON-C</primary>
+ <primary sortas="a-json-c">json-c</primary>
</indexterm>
<sect2 role="package">
- <title>Introduction to JSON-C</title>
+ <title>Introduction to json-c</title>
<para>
- The <application>JSON-C</application> implements a reference counting
+ The <application>json-c</application> implements a reference counting
object model that allows you to easily construct JSON objects in C,
output them as JSON formatted strings and parse JSON formatted strings
back into the C representation of JSON objects.
@@ -68,7 +67,7 @@
</listitem>
</itemizedlist>
- <bridgehead renderas="sect3">JSON-C Dependencies</bridgehead>
+ <bridgehead renderas="sect3">json-c Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
@@ -84,7 +83,7 @@
</sect2>
<sect2 role="installation">
- <title>Installation of JSON-C</title>
+ <title>Installation of json-c</title>
<!--
<note>
<para>
@@ -103,7 +102,7 @@
sed -i 's/VERSION 3.9/VERSION 4.0/' tests/CMakeLists.txt</userinput></screen>
<para>
- Install <application>JSON-C</application> by running the following
+ Install <application>json-c</application> by running the following
commands:
</para>
@@ -184,7 +183,7 @@ install -v -m644 doc/html/* /usr/share/doc/json-c-&json-c-version;</userinput></
<term><filename class="libraryfile">libjson-c.so</filename></term>
<listitem>
<para>
- contains the <application>JSON-C</application> API functions
+ contains the <application>json-c</application> API functions
</para>
<indexterm zone="json-c libjson-c">
<primary sortas="c-libjson-c">libjson-c.so</primary>
diff --git a/general/genlib/json-glib.xml b/general/genlib/json-glib.xml
index 403c553790..714534affa 100644
--- a/general/genlib/json-glib.xml
+++ b/general/genlib/json-glib.xml
@@ -12,21 +12,21 @@
<!ENTITY json-glib-time "0.1 SBU (with tests)">
]>
-<sect1 id="json-glib" xreflabel="JSON-GLib-&json-glib-version;">
+<sect1 id="json-glib" xreflabel="json-glib-&json-glib-version;">
<?dbhtml filename="json-glib.html"?>
- <title>JSON-GLib-&json-glib-version;</title>
+ <title>json-glib-&json-glib-version;</title>
<indexterm zone="json-glib">
- <primary sortas="a-JSON-GLib">JSON-GLib</primary>
+ <primary sortas="a-json-glib">json-glib</primary>
</indexterm>
<sect2 role="package">
- <title>Introduction to JSON GLib</title>
+ <title>Introduction to json glib</title>
<para>
- The <application>JSON GLib</application> package is a library
+ The <application>json glib</application> package is a library
providing serialization and deserialization support for the JavaScript
Object Notation (JSON) format described by RFC 4627.
</para>
@@ -67,7 +67,7 @@
</listitem>
</itemizedlist>
- <bridgehead renderas="sect3">JSON-GLib Dependencies</bridgehead>
+ <bridgehead renderas="sect3">json-glib Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
@@ -84,10 +84,10 @@
</sect2>
<sect2 role="installation">
- <title>Installation of JSON GLib</title>
+ <title>Installation of json glib</title>
<para>
- Install <application>JSON GLib</application> by running the following
+ Install <application>json glib</application> by running the following
commands:
</para>
@@ -197,7 +197,7 @@ ninja</userinput></screen>
<term><filename class="libraryfile">libjson-glib-1.0.so</filename></term>
<listitem>
<para>
- contains the <application>JSON GLib</application> API functions
+ contains the <application>json glib</application> API functions
</para>
<indexterm zone="json-glib libjson-glib-1">
<primary sortas="c-libjson-glib-1">libjson-glib-1.0.so</primary>
diff --git a/general/genlib/nlohmann-json.xml b/general/genlib/nlohmann-json.xml
index c7371ae8ea..879c13ed32 100644
--- a/general/genlib/nlohmann-json.xml
+++ b/general/genlib/nlohmann-json.xml
@@ -15,10 +15,10 @@
<sect1 id="nlohmann-json" xreflabel="nlohmann-json-&nlohmann-json-version;">
<?dbhtml filename="nlohmann-json.html"?>
- <title>nlohmann-json-&nlohmann-json-version;</title>
+ <title>json-&nlohmann-json-version; (nlohmann-json)</title>
<indexterm zone="nlohmann-json">
- <primary sortas="a-nlohmann-json">nlohmann-json</primary>
+ <primary sortas="a-nlohmann-json">json</primary>
</indexterm>
<sect2 role="package">
diff --git a/x/installing/wayfire.xml b/x/installing/wayfire.xml
index fcc9a0b0ad..4511393ec3 100644
--- a/x/installing/wayfire.xml
+++ b/x/installing/wayfire.xml
@@ -12,17 +12,17 @@
<!ENTITY wayfire-time "0.5 SBU (with parallelism=4)">
]>
-<sect1 id="wayfire" xreflabel="Wayfire-&wayfire-version;">
+<sect1 id="wayfire" xreflabel="wayfire-&wayfire-version;">
<?dbhtml filename="wayfire.html"?>
- <title>Wayfire-&wayfire-version;</title>
+ <title>wayfire-&wayfire-version;</title>
<indexterm zone="wayfire">
- <primary sortas="a-wayfire">Wayfire</primary>
+ <primary sortas="a-wayfire">wayfire</primary>
</indexterm>
<sect2 role="package">
- <title>Introduction to Wayfire</title>
+ <title>Introduction to wayfire</title>
<para>
Wayfire is a Wayland compositor which takes a lot of effects from the now
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
--
http://lists.linuxfromscratch.org/sympa/info/blfs-book
Unsubscribe: See the above information page