travis: add more ASan options

[thirdparty/systemd.git] / man / sd_bus_path_encode.xml

diff --git a/man/sd_bus_path_encode.xml b/man/sd_bus_path_encode.xml
index 696dfd00ba89a11e3e9ca825dda3196f7d4159a5..ade11bc15e1537d8a8cd8b9f57b315d2808a19cf 100644 (file)
--- a/man/sd_bus_path_encode.xml
+++ b/man/sd_bus_path_encode.xml
@@ -1,40 +1,13 @@
-<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<?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+ -->
 
-<!--
-  This file is part of systemd.
-
-  Copyright 2014 Zbigniew Jędrzejewski-Szmek
-
-  systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU Lesser General Public License as published by
-  the Free Software Foundation; either version 2.1 of the License, or
-  (at your option) any later version.
-
-  systemd is distributed in the hope that it will be useful, but
-  WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public License
-  along with systemd; If not, see <http://www.gnu.org/licenses/>.
--->
-
-<refentry id="sd_bus_path_encode">
+<refentry id="sd_bus_path_encode" xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
     <title>sd_bus_path_encode</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>A monkey with a typewriter</contrib>
-        <firstname>Zbigniew</firstname>
-        <surname>Jędrzejewski-Szmek</surname>
-        <email>zbyszek@in.waw.pl</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
@@ -66,7 +39,7 @@
         <funcdef>int <function>sd_bus_path_encode_many</function></funcdef>
         <paramdef>char **<parameter>out</parameter></paramdef>
         <paramdef>const char *<parameter>path_template</parameter></paramdef>
-        <paramdef>...</paramdef>
+        <paramdef>…</paramdef>
       </funcprototype>
 
       <funcprototype>
@@ -80,7 +53,7 @@
         <funcdef>int <function>sd_bus_path_decode_many</function></funcdef>
         <paramdef>const char *<parameter>path</parameter></paramdef>
         <paramdef>const char *<parameter>path_template</parameter></paramdef>
-        <paramdef>...</paramdef>
+        <paramdef>…</paramdef>
       </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
@@ -104,7 +77,7 @@
     always be <constant>NUL</constant>-terminated. The returned string
     will be the concatenation of the bus path prefix plus an escaped
     version of the external identifier string. This operation may be
-    reversed with <function>sd_bus_decode()</function>. It is
+    reversed with <function>sd_bus_path_decode()</function>. It is
     recommended to only use external identifiers that generally
     require little escaping to be turned into valid bus path
     identifiers (for example, by sticking to a 7-bit ASCII character
@@ -128,23 +101,23 @@
 
     <para><function>sd_bus_path_encode_many()</function> works like
     its counterpart <function>sd_bus_path_encode()</function>, but
-    takes a path-template as argument and encodes multiple labels
+    takes a path template as argument and encodes multiple labels
     according to its embedded directives. For each
     <literal>%</literal> character found in the template, the caller
-    must provide a string via var-args, which will be encoded and
+    must provide a string via varargs, which will be encoded and
     embedded at the position of the <literal>%</literal> character.
     Any other character in the template is copied verbatim into the
     encoded path.</para>
 
     <para><function>sd_bus_path_decode_many()</function> does the
     reverse of <function>sd_bus_path_encode_many()</function>. It
-    decodes the passed object path, according to the given
-    path-template. For each <literal>%</literal> character in the
+    decodes the passed object path according to the given
+    path template. For each <literal>%</literal> character in the
     template, the caller must provide an output storage
-    (<literal>char **</literal>) via var-args. The decoded label
+    (<literal>char **</literal>) via varargs. The decoded label
     will be stored there. Each <literal>%</literal> character will
     only match the current label. It will never match across labels.
-    Furthermore, only a single such directive is allowed per label.
+    Furthermore, only a single directive is allowed per label.
     If <literal>NULL</literal> is passed as output storage, the
     label is verified but not returned to the caller.</para>
   </refsect1>
@@ -165,15 +138,7 @@
     by the caller.</para>
   </refsect1>
 
-  <refsect1>
-    <title>Notes</title>
-
-    <para><function>sd_bus_path_encode()</function> and
-    <function>sd_bus_path_decode()</function> are available as a
-    shared library, which can be compiled and linked to with the
-    <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-    file.</para>
-  </refsect1>
+  <xi:include href="libsystemd-pkgconfig.xml" />
 
   <refsect1>
     <title>See Also</title>