man: reword descriptions of numerical fields

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.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek
2025-05-28 15:30:05 +02:00
parent 948369983c
commit de8d2894b8
2 changed files with 19 additions and 20 deletions

View File

@@ -127,8 +127,8 @@
<para>Note that the journal service does not validate the values of any structured <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 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, 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 or log level are expected to do so properly formatted, i.e. as integers formatted
as decimal strings.</para> as decimals.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -206,11 +206,10 @@
<term><varname>_UID=</varname></term> <term><varname>_UID=</varname></term>
<term><varname>_GID=</varname></term> <term><varname>_GID=</varname></term>
<listitem> <listitem>
<para>The process, user, and group ID of the process the <para>The process number, user number, and group number of the process the journal entry originates
journal entry originates from formatted as a decimal from formatted as decimals. Note that entries obtained via <literal>stdout</literal> or
string. Note that entries obtained via <literal>stdout</literal> or <literal>stderr</literal> of forked processes will contain credentials valid for a parent process
<literal>stderr</literal> of forked processes will contain credentials valid for a parent (that initiated the connection to <command>systemd-journald</command>).</para>
process (that initiated the connection to <command>systemd-journald</command>).</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -273,17 +272,17 @@
<varlistentry> <varlistentry>
<term><varname>_SOURCE_REALTIME_TIMESTAMP=</varname></term> <term><varname>_SOURCE_REALTIME_TIMESTAMP=</varname></term>
<listitem> <listitem>
<para>The earliest trusted timestamp of the message, if any is known that is different from <para>The earliest trusted timestamp of the message, if any is known that is different from the
the reception time of the journal. The timestamp is in the <constant>CLOCK_REALTIME</constant> reception time of the journal. The timestamp is the <constant>CLOCK_REALTIME</constant> time in
clock in microseconds, formatted as decimal strings.</para> microseconds, formatted as a decimal.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>_SOURCE_BOOTTIME_TIMESTAMP=</varname></term> <term><varname>_SOURCE_BOOTTIME_TIMESTAMP=</varname></term>
<listitem> <listitem>
<para>The earliest trusted timestamp of the message in <constant>CLOCK_BOOTTIME</constant> clock. <para>The earliest trusted timestamp of the message in the <constant>CLOCK_BOOTTIME</constant>
For details, refer to <varname>_SOURCE_REALTIME_TIMESTAMP=</varname>.</para> time, in the same format as <varname>_SOURCE_REALTIME_TIMESTAMP=</varname>.</para>
<xi:include href="version-info.xml" xpointer="v257"/> <xi:include href="version-info.xml" xpointer="v257"/>
</listitem> </listitem>
@@ -301,8 +300,7 @@
<varlistentry> <varlistentry>
<term><varname>_MACHINE_ID=</varname></term> <term><varname>_MACHINE_ID=</varname></term>
<listitem> <listitem>
<para>The machine ID of the originating host, as available <para>The machine ID of the originating host, as described in
in
<citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -322,7 +320,7 @@
<varlistentry> <varlistentry>
<term><varname>_HOSTNAME=</varname></term> <term><varname>_HOSTNAME=</varname></term>
<listitem> <listitem>
<para>The name of the originating host.</para> <para>The hostname of the originating host.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -646,7 +644,7 @@
<para>The wallclock time <para>The wallclock time
(<constant>CLOCK_REALTIME</constant>) at the point in time (<constant>CLOCK_REALTIME</constant>) at the point in time
the entry was received by the journal, in microseconds since 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 different properties from
<literal>_SOURCE_REALTIME_TIMESTAMP=</literal>, as it is <literal>_SOURCE_REALTIME_TIMESTAMP=</literal>, as it is
usually a bit later but more likely to be monotonic. usually a bit later but more likely to be monotonic.
@@ -660,7 +658,7 @@
<para>The monotonic time <para>The monotonic time
(<constant>CLOCK_MONOTONIC</constant>) at the point in time (<constant>CLOCK_MONOTONIC</constant>) at the point in time
the entry was received by the journal in microseconds, 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 for the entry, this should be combined with the boot ID in
<literal>_BOOT_ID=</literal>. <literal>_BOOT_ID=</literal>.
</para> </para>

View File

@@ -451,9 +451,10 @@
than 16381 (2¹⁴-1) were ignored. For s390 PCI devices index values up to 65535 (2¹⁶-1) are valid. 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> To account for that, the limit was increased to 65535.</para>
<para>The udev rule <varname>NAME=</varname> replaces <literal>:</literal>, <para>The <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
<literal>/</literal>, and <literal>%</literal> with an underscore (<literal>_</literal>), and rule <varname>NAME=</varname> replaces <literal>:</literal>, <literal>/</literal>, and
refuses strings which contain only numerics.</para> <literal>%</literal> with an underscore (<literal>_</literal>), and refuses strings which contain
only digits.</para>
<xi:include href="version-info.xml" xpointer="v249"/> <xi:include href="version-info.xml" xpointer="v249"/>
</listitem> </listitem>