chiark / gitweb /
cryptsetup-generator: Add support for naming luks devices on kernel cmdline
[elogind.git] / man / sd_bus_path_encode.xml
index 5c166d072bea96a634216143b6b63e0de2ad9782..55a6fd0056f6b4dd3ec4c451e9aecb8f147ecb4e 100644 (file)
@@ -1,4 +1,4 @@
-<?xml version='1.0'?> <!--*-nxml-*-->
+<?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">
 
@@ -82,16 +82,16 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     prefix and an external identifier string as arguments, plus a
     place to store the returned bus path string. The bus path prefix
     must be a valid bus path, starting with a slash
-    <literal>/</literal>, but not ending in one. The external
-    identifier string may be in any format, may be the empty string
-    and no restrictions on the charset are made - however it must
+    <literal>/</literal>, and not ending in one. The external
+    identifier string may be in any format, may be the empty string,
+    and has no restrictions on the charset — however, it must
     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
-    recommended to only use external identifiers here that generally
+    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 7bit ASCII character
+    identifiers (for example, by sticking to a 7-bit ASCII character
     set), in order to ensure the resulting bus path is still short and
     easily processed.</para>
 
@@ -101,12 +101,12 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     takes a bus path and a prefix string, plus a place to store the
     returned external identifier string. If the bus path does not
     start with the specified prefix, 0 is returned and the returned
-    string is set to <constant>NULL</constant>. Otherwise the the
+    string is set to <constant>NULL</constant>. Otherwise, the
     string following the prefix is unescaped and returned in the
     external identifier string.</para>
 
-    <para>The escaping used will will replace all characters which are
-    invalid in a bus object path by <literal>_</literal> followed by a
+    <para>The escaping used will replace all characters which are
+    invalid in a bus object path by <literal>_</literal>, followed by a
     hexadecimal value. As a special case, the empty string will be
     replaced by a lone <literal>_</literal>.</para>
   </refsect1>
@@ -118,12 +118,12 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     returns positive or 0, and a valid bus path in the return
     argument. On success, <function>sd_bus_path_decode()</function>
     returns a positive value if the prefixed matched, or 0 if it
-    didn't. If the prefix matched the external identifier is returned
-    in the return parameter. If it did not match NULL is returned in
+    did not. If the prefix matched, the external identifier is returned
+    in the return parameter. If it did not match, NULL is returned in
     the return parameter. On failure, a negative errno-style error
     number is returned by either function. The returned strings must
     be
-    <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>'d
+    <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>'d
     by the caller.</para>
   </refsect1>
 
@@ -133,7 +133,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <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><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     file.</para>
   </refsect1>
 
@@ -143,7 +143,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para>
       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+      <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     </para>
   </refsect1>