morgan/systemd
1
0
Fork 0
mirror of https://github.com/morgan9e/systemd synced 2026-04-14 00:14:32 +09:00
Code Issues Packages Projects Releases Wiki Activity

man: reword descriptions of numerical fields

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

32
man/systemd.journal-fields.xml
View File

@@ -127,8 +127,8 @@
<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>
@@ -206,11 +206,10 @@
<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>
@@ -273,17 +272,17 @@
<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>
@@ -301,8 +300,7 @@
<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>
@@ -322,7 +320,7 @@
<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>
@@ -646,7 +644,7 @@
<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.
@@ -660,7 +658,7 @@
<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>

7
man/systemd.net-naming-scheme.xml
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.
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>