chiark / gitweb /
analyze: change behaviour of combined --to/from--pattern
[elogind.git] / man / sd_bus_error.xml
index 38bc303..d1929c2 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">
 
@@ -21,7 +21,7 @@ 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_error">
+<refentry id="sd_bus_error" conditional="ENABLE_KDBUS">
 
   <refentryinfo>
     <title>sd_bus_error</title>
@@ -54,7 +54,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <refname>sd_bus_error_is_set</refname>
     <refname>sd_bus_error_has_name</refname>
 
-    <refpurpose>libsystemd-bus error handling</refpurpose>
+    <refpurpose>sd-bus error handling</refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
@@ -231,10 +231,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
   <refsect1>
     <title>Description</title>
 
-    <para><structname>sd_bus_error</structname> structure carries
-    information for a <filename>libsystemd-bus</filename> error.
-    Functions described below can be used to set and query fields in
-    this structure. Field <structfield>name</structfield> contains a
+    <para>The <structname>sd_bus_error</structname> structure carries
+    information for a <filename>sd-bus</filename> error. The
+    functions described below can be used to set and query fields in
+    this structure. The <structfield>name</structfield> field contains a
     short identifier of an error. It should follow the rules for error
     names described in the D-Bus specification, subsection <ulink
     url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names">Valid
@@ -246,21 +246,21 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_bus_error_set</function> will return an
     errno-like negative value returned based on parameter
     <parameter>name</parameter> (see
-    <citerefentry><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
+    <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
     Various well-known D-Bus errors are converted to specific values,
     and the remaining ones to <constant>-ENXIO</constant>. Well-known
     D-Bus error names are available as constants
     <constant>SD_BUS_ERROR_FAILED</constant>, etc., listed above. If
-    <parameter>name</parameter> is <constant>NULL</constant>, it is is
-    assumed that no error occured, and 0 is returned. This means that
+    <parameter>name</parameter> is <constant>NULL</constant>, it is
+    assumed that no error occurred, and 0 is returned. This means that
     this function may be conveniently used in a
     <function>return</function> statement.</para>
 
     <para>If <parameter>e</parameter> is not
     <constant>NULL</constant>, <structfield>name</structfield> and
-    <structfield>message</structfield> will be filled-in in the
+    <structfield>message</structfield> in the
     <structname>sd_bus_error</structname> structure
-    <parameter>e</parameter> points at. As described above,
+    <parameter>e</parameter> points at will be filled in. As described above,
     <parameter>name</parameter> may be <constant>NULL</constant>,
     which is treated as no error. Parameter
     <parameter>message</parameter> may also be
@@ -270,7 +270,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <para><function>sd_bus_error_setf</function> is similar to
     <function>sd_bus_error_set</function>, but takes a
-    <citerefentry><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    <citerefentry project='man-pages'><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     format string and corresponding arguments to generate
     <structname>message</structname>.</para>
 
@@ -291,22 +291,23 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_bus_error_set_errnof</function> is similar to
     <function>sd_bus_error_set_errno</function>, but in addition to
     <parameter>name</parameter>, takes a
-    <citerefentry><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    <citerefentry project='man-pages'><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     format and corresponding arguments.
     <structfield>name</structfield> will be generated from
     <parameter>format</parameter> and the arguments.</para>
 
-    <para><function>sd_bus_error_get_errno</function> is will convert
-    <structname>e->name</structname> to an errno-like value
-    using the same rules as <function>sd_bus_error_set</function>.
-    </para>
+    <para><function>sd_bus_error_get_errno</function> will convert
+    <structname>e-&gt;name</structname> to an errno-like value using the
+    same rules as <function>sd_bus_error_set</function>.  If
+    <parameter>e</parameter> is <constant>NULL</constant>, 0 will be
+    returned.</para>
 
     <para><function>sd_bus_error_copy</function> will initialize
     <parameter>dst</parameter> using the values in
     <parameter>e</parameter>. If the strings in
     <parameter>e</parameter> were set using
     <function>sd_bus_set_error_const</function>, they will be shared.
-    Otherwie they wil be copied.</para>
+    Otherwise, they will be copied.</para>
 
     <para><function>sd_bus_error_is_set</function> will return
     <constant>true</constant> if <parameter>e</parameter> is
@@ -321,7 +322,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_bus_error_free</function> will destroy resources
     held by <parameter>e</parameter>. The parameter itself will not
     be deallocated, and 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 if necessary.</para>
   </refsect1>
 
@@ -342,7 +343,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_bus_error_get_errno</function> returns
     <constant>false</constant> when <parameter>e</parameter> is
     <constant>NULL</constant>, and a positive errno value mapped from
-    <parameter>e->name</parameter> otherwise.</para>
+    <parameter>e-&gt;name</parameter> otherwise.</para>
 
     <para><function>sd_bus_error_copy</function> returns 0 or a
     positive integer on success, and one of the negative error values
@@ -350,12 +351,12 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <para><function>sd_bus_error_is_set</function> returns
     <constant>true</constant> when <parameter>e</parameter> and
-    <parameter>e->name</parameter> are non-<constant>NULL</constant>,
+    <parameter>e-&gt;name</parameter> are non-<constant>NULL</constant>,
     <constant>false</constant> otherwise.</para>
 
     <para><function>sd_bus_error_has_name</function> returns
     <constant>true</constant> when <parameter>e</parameter> is
-    non-<constant>NULL</constant> and <parameter>e->name</parameter>
+    non-<constant>NULL</constant> and <parameter>e-&gt;name</parameter>
     is equal to <parameter>name</parameter>,
     <constant>false</constant> otherwise.</para>
   </refsect1>
@@ -375,7 +376,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <variablelist>
 
       <varlistentry>
-        <term><varname>-EINVAL</varname></term>
+        <term><constant>-EINVAL</constant></term>
 
         <listitem><para>Error was already set in
         <structname>sd_bus_error</structname> structure when one the
@@ -383,7 +384,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><varname>-ENOMEM</varname></term>
+        <term><constant>-ENOMEM</constant></term>
 
         <listitem><para>Memory allocation failed.</para></listitem>
       </varlistentry>
@@ -396,7 +397,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_bus_set_error()</function> and other functions
     described here are available as a shared library, which can be
     compiled and linked to with the
-    <constant>libsystemd-bus</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>
 
@@ -406,7 +407,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>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     </para>
   </refsect1>