man: add docs for the new functions

diff --git a/man/rules/meson.build b/man/rules/meson.build
index 941e248d72acadedfc9513248d574503b2f7bc45..78440e6e91cf5046b4be6856ad4161ddd6e7d845 100644 (file)
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -267,6 +267,12 @@ manpages = [
  ['sd_bus_get_n_queued_read', '3', ['sd_bus_get_n_queued_write'], ''],
  ['sd_bus_get_name_creds', '3', ['sd_bus_get_owner_creds'], ''],
  ['sd_bus_get_name_machine_id', '3', [], ''],
+ ['sd_bus_interface_name_is_valid',
+  '3',
+  ['sd_bus_member_name_is_valid',
+   'sd_bus_object_path_is_valid',
+   'sd_bus_service_name_is_valid'],
+  ''],
  ['sd_bus_is_open', '3', ['sd_bus_is_ready'], ''],
  ['sd_bus_list_names', '3', [], ''],
  ['sd_bus_message_append', '3', ['sd_bus_message_appendv'], ''],

diff --git a/man/sd-bus.xml b/man/sd-bus.xml
index 24999337c8f74cd2fa7969696e9952c2c7651870..0938255d5c02cc8313722c8c17d22ae61b309dde 100644 (file)
--- a/man/sd-bus.xml
+++ b/man/sd-bus.xml
@@ -89,6 +89,7 @@
 <citerefentry><refentrytitle>sd_bus_get_scope</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_get_tid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_get_unique_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>sd_bus_interface_name_is_valid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_is_monitor</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_is_bus_client</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_is_server</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

diff --git a/man/sd_bus_interface_name_is_valid.xml b/man/sd_bus_interface_name_is_valid.xml
new file mode 100644 (file)
index 0000000..73c0ba1
--- /dev/null
+++ b/man/sd_bus_interface_name_is_valid.xml
@@ -0,0 +1,98 @@
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
+
+<refentry id="sd_bus_interface_name_is_valid" xmlns:xi="http://www.w3.org/2001/XInclude">
+  <refentryinfo>
+    <title>sd_bus_interface_name_is_valid</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>sd_bus_interface_name_is_valid</refentrytitle>
+    <manvolnum>3</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>sd_bus_interface_name_is_valid</refname>
+    <refname>sd_bus_service_name_is_valid</refname>
+    <refname>sd_bus_member_name_is_valid</refname>
+    <refname>sd_bus_object_path_is_valid</refname>
+
+    <refpurpose>Check if a string is a valid bus name or object path</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <funcsynopsis>
+      <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
+
+      <funcprototype>
+        <funcdef>int <function>sd_bus_interface_name_is_valid</function></funcdef>
+        <paramdef>const char* <parameter>p</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>int <function>sd_bus_service_name_is_valid</function></funcdef>
+        <paramdef>const char* <parameter>p</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>int <function>sd_bus_member_name_is_valid</function></funcdef>
+        <paramdef>const char* <parameter>p</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>int <function>sd_bus_object_path_is_valid</function></funcdef>
+        <paramdef>const char* <parameter>p</parameter></paramdef>
+      </funcprototype>
+    </funcsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><function>sd_bus_interface_name_is_valid()</function> checks if a given string
+    <parameter>p</parameter> is a syntactically valid bus interface name. Similarly,
+    <function>sd_bus_service_name_is_valid()</function> checks if the argument is a valid bus service name,
+    <function>sd_bus_member_name_is_valid()</function> checks if the argument is a valid bus interface member
+    name, and <function>sd_bus_object_path_is_valid()</function> checks if the argument is a valid bus object
+    path. Those functions generally check that only allowed characters are used and that the length of the
+    string is within limits.</para>
+  </refsect1>
+
+  <refsect1>
+    <title>Return Value</title>
+
+    <para>Those functions return 1 if the argument is a valid interface / service / member name or object
+    path, and 0 if it is not. If the argument is NULL, an error is returned.</para>
+
+    <refsect2>
+      <title>Errors</title>
+
+      <para>Returned errors may indicate the following problems:</para>
+
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
+
+          <listitem><para>The <parameter>p</parameter> parameter is
+          <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+  </refsect1>
+
+  <xi:include href="libsystemd-pkgconfig.xml" />
+
+  <refsect1>
+    <title>See Also</title>
+
+    <para>
+      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_bus_message_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>