[systemd-devel] [PATCH 2/2] man: be more explicit about option arguments that take 128-bit IDs in journalctl(1)

[Jason St. John]

It may not be immediately obvious to the reader what "ID128" is, so replace the
example option argument "ID128" with "128-bit-ID".
---
"ID128" is developer jargon/shorthand for "128-bit ID" that is regularly used in
function definitions. For those new to systemd, non-native English speakers, or
for those using translators, "128-bit-ID" will hopefully be more helpful than
"ID128".

I broke this off into its own patch because I expect this to be more contentious
than the first patch in this set.


 man/journalctl.xml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/man/journalctl.xml b/man/journalctl.xml
index c196ce3..23bb960 100644
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -744,7 +744,7 @@
 
                         <varlistentry>
                                 <term><option>--list-catalog
-                                <optional><replaceable>ID128...</replaceable></optional>
+                                <optional><replaceable>128-bit-ID...</replaceable></optional>
                                 </option></term>
 
                                 <listitem><para>List the contents of
@@ -753,7 +753,7 @@
                                 description strings.</para>
 
                                 <para>If any
-                                <replaceable>ID128</replaceable>s are
+                                <replaceable>128-bit-ID</replaceable>s are
                                 specified, only those entries are shown.
                                 </para>
                                 </listitem>
@@ -761,7 +761,7 @@
 
                         <varlistentry>
                                 <term><option>--dump-catalog
-                                <optional><replaceable>ID128...</replaceable></optional>
+                                <optional><replaceable>128-bit-ID...</replaceable></optional>
                                 </option></term>
 
                                 <listitem><para>Show the contents of
@@ -772,7 +772,7 @@
                                 files).</para>
 
                                 <para>If any
-                                <replaceable>ID128</replaceable>s are
+                                <replaceable>128-bit-ID</replaceable>s are
                                 specified, only those entries are shown.
                                 </para>
                                 </listitem>
-- 
1.8.5.1