From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Mon, 19 Apr 2021 13:33:09 +0000 (+0200)
Subject: man: mention sd_id128_is_allf(), SD_ID128_ALLF
X-Git-Tag: v249-rc1~368^2~3
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=78aa5b6f59f1787bcd509f8070f82ae72add0fd9;p=thirdparty%2Fsystemd.git

man: mention sd_id128_is_allf(), SD_ID128_ALLF

It was added in 670814387ba8973245c08123e7240669f51a55a8, but not
mentioned in the man pages.
---

diff --git a/man/rules/meson.build b/man/rules/meson.build
index 7ef26cb2c62..c21f1b6b4c1 100644
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -119,7 +119,8 @@ manpages = [
  ['sd-hwdb', '3', [], ''],
  ['sd-id128',
   '3',
-  ['SD_ID128_CONST_STR',
+  ['SD_ID128_ALLF',
+   'SD_ID128_CONST_STR',
    'SD_ID128_FORMAT_STR',
    'SD_ID128_FORMAT_VAL',
    'SD_ID128_MAKE',
@@ -127,6 +128,7 @@ manpages = [
    'SD_ID128_NULL',
    'SD_ID128_UUID_FORMAT_STR',
    'sd_id128_equal',
+   'sd_id128_is_allf',
    'sd_id128_is_null',
    'sd_id128_t'],
   ''],
diff --git a/man/sd-id128.xml b/man/sd-id128.xml
index 2005cd19db8..c448d60a940 100644
--- a/man/sd-id128.xml
+++ b/man/sd-id128.xml
@@ -18,16 +18,18 @@
 
   <refnamediv>
     <refname>sd-id128</refname>
-    <refname>sd_id128_t</refname>
+    <refname>SD_ID128_ALLF</refname>
+    <refname>SD_ID128_CONST_STR</refname>
+    <refname>SD_ID128_FORMAT_STR</refname>
+    <refname>SD_ID128_FORMAT_VAL</refname>
     <refname>SD_ID128_MAKE</refname>
     <refname>SD_ID128_MAKE_STR</refname>
     <refname>SD_ID128_NULL</refname>
-    <refname>SD_ID128_CONST_STR</refname>
-    <refname>SD_ID128_FORMAT_STR</refname>
     <refname>SD_ID128_UUID_FORMAT_STR</refname>
-    <refname>SD_ID128_FORMAT_VAL</refname>
     <refname>sd_id128_equal</refname>
+    <refname>sd_id128_is_allf</refname>
     <refname>sd_id128_is_null</refname>
+    <refname>sd_id128_t</refname>
     <refpurpose>APIs for processing 128-bit IDs</refpurpose>
   </refnamediv>
 
@@ -85,7 +87,7 @@
 
     <programlisting>#define SD_MESSAGE_COREDUMP SD_ID128_MAKE(fc,2e,22,bc,6e,e6,47,b6,b9,07,29,ab,34,a2,50,b1)</programlisting>
 
-    <para><constant>SD_ID128_NULL</constant> may be used to refer to the 128bit ID consisting of only
+    <para><constant>SD_ID128_NULL</constant> may be used to refer to the 128-bit ID consisting of only
     <constant>NUL</constant> bytes.</para>
 
     <para><function>SD_ID128_MAKE_STR()</function> is similar to <function>SD_ID128_MAKE()</function>, but creates a
@@ -136,12 +138,15 @@ int main(int argc, char **argv) {
   return 0;
 }</programlisting>
 
-    <para>Use <function>sd_id128_is_null()</function> to check if an 128bit ID consists of only
+    <para>Use <function>sd_id128_is_null()</function> to check if an 128-bit ID consists of only
     <constant>NUL</constant> bytes:</para>
 
-    <programlisting>int main(int argc, char *argv[]) {
-  assert(sd_id128_is_null(SD_ID128_NULL));
-}</programlisting>
+    <programlisting>assert(sd_id128_is_null(SD_ID128_NULL));</programlisting>
+
+    <para>Similarly, use <function>sd_id128_is_allf()</function> to check if an 128-bit ID consists of only
+    <constant>0xFF</constant> bytes (all bits on):</para>
+
+    <programlisting>assert(sd_id128_is_allf(SD_ID128_ALLF));</programlisting>
 
     <para>Note that new, randomized IDs may be generated with
     <citerefentry><refentrytitle>systemd-id128</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s