]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: reword descriptions of numerical fields
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Wed, 28 May 2025 13:30:05 +0000 (15:30 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Wed, 28 May 2025 13:34:47 +0000 (15:34 +0200)
A "string" is a concept in C. In a text-based API, this is implicit, especially
if we say that something was "formatted". So change occurences of "decimal
string" to just "decimal". Similarly, "numerics" is unclear, say "digits".

Also, a "timestamp is in a clock" just sounds wrong. Reword those sentences.

man/systemd.journal-fields.xml
man/systemd.net-naming-scheme.xml

index b7a72af08b0cc356a757f8368e8335775d86c0dc..9f7f2c5cfa0b2ec09f175dcf60e41926c0b25c45 100644 (file)
           <para>Note that the journal service does not validate the values of any structured
           journal fields whose name is not prefixed with an underscore, and this includes any
           syslog related fields such as these. Hence, applications that supply a facility, PID,
-          or log level are expected to do so properly formatted, i.e. as numeric integers formatted
-          as decimal strings.</para>
+          or log level are expected to do so properly formatted, i.e. as integers formatted
+          as decimals.</para>
         </listitem>
       </varlistentry>
 
         <term><varname>_UID=</varname></term>
         <term><varname>_GID=</varname></term>
         <listitem>
-          <para>The process, user, and group ID of the process the
-          journal entry originates from formatted as a decimal
-          string. Note that entries obtained via <literal>stdout</literal> or
-          <literal>stderr</literal> of forked processes will contain credentials valid for a parent
-          process (that initiated the connection to <command>systemd-journald</command>).</para>
+          <para>The process number, user number, and group number of the process the journal entry originates
+          from formatted as decimals. Note that entries obtained via <literal>stdout</literal> or
+          <literal>stderr</literal> of forked processes will contain credentials valid for a parent process
+          (that initiated the connection to <command>systemd-journald</command>).</para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
         <term><varname>_SOURCE_REALTIME_TIMESTAMP=</varname></term>
         <listitem>
-          <para>The earliest trusted timestamp of the message, if any is known that is different from
-          the reception time of the journal. The timestamp is in the <constant>CLOCK_REALTIME</constant>
-          clock in microseconds, formatted as decimal strings.</para>
+          <para>The earliest trusted timestamp of the message, if any is known that is different from the
+          reception time of the journal. The timestamp is the <constant>CLOCK_REALTIME</constant> time in
+          microseconds, formatted as a decimal.</para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
         <term><varname>_SOURCE_BOOTTIME_TIMESTAMP=</varname></term>
         <listitem>
-          <para>The earliest trusted timestamp of the message in <constant>CLOCK_BOOTTIME</constant> clock.
-          For details, refer to <varname>_SOURCE_REALTIME_TIMESTAMP=</varname>.</para>
+          <para>The earliest trusted timestamp of the message in the <constant>CLOCK_BOOTTIME</constant>
+          time, in the same format as <varname>_SOURCE_REALTIME_TIMESTAMP=</varname>.</para>
 
           <xi:include href="version-info.xml" xpointer="v257"/>
         </listitem>
       <varlistentry>
         <term><varname>_MACHINE_ID=</varname></term>
         <listitem>
-          <para>The machine ID of the originating host, as available
-          in
+          <para>The machine ID of the originating host, as described in
           <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term><varname>_HOSTNAME=</varname></term>
         <listitem>
-          <para>The name of the originating host.</para>
+          <para>The hostname of the originating host.</para>
         </listitem>
       </varlistentry>
 
           <para>The wallclock time
           (<constant>CLOCK_REALTIME</constant>) at the point in time
           the entry was received by the journal, in microseconds since
-          the epoch UTC, formatted as a decimal string. This has
+          the epoch UTC, formatted as a decimal. This has
           different properties from
           <literal>_SOURCE_REALTIME_TIMESTAMP=</literal>, as it is
           usually a bit later but more likely to be monotonic.
           <para>The monotonic time
           (<constant>CLOCK_MONOTONIC</constant>) at the point in time
           the entry was received by the journal in microseconds,
-          formatted as a decimal string. To be useful as an address
+          formatted as a decimal. To be useful as an address
           for the entry, this should be combined with the boot ID in
           <literal>_BOOT_ID=</literal>.
           </para>
index 96688ed3c91c39d3dd09aec7b406f743552e5d75..24f2592b841f17d81234593de6a7bfef1bbc9a5f 100644 (file)
           than 16381 (2¹⁴-1) were ignored. For s390 PCI devices index values up to 65535 (2¹⁶-1) are valid.
           To account for that, the limit was increased to 65535.</para>
 
-          <para>The udev rule <varname>NAME=</varname> replaces <literal>:</literal>,
-          <literal>/</literal>, and <literal>%</literal> with an underscore (<literal>_</literal>), and
-          refuses strings which contain only numerics.</para>
+          <para>The <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+          rule <varname>NAME=</varname> replaces <literal>:</literal>, <literal>/</literal>, and
+          <literal>%</literal> with an underscore (<literal>_</literal>), and refuses strings which contain
+          only digits.</para>
 
           <xi:include href="version-info.xml" xpointer="v249"/>
           </listitem>