picnoir/Systemd
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

man/catalog: fix synopsis and remind to free

Browse source
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2013-03-15 18:10:51 -04:00
parent 6531dac67c
commit 0d1aaec228
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
man/sd_journal_get_catalog.xml
View file

@ -55,13 +55,13 @@
<funcprototype>
<funcdef>int <function>sd_journal_get_catalog</function></funcdef>
<paramdef>sd_journal* <parameter>j</parameter></paramdef>
<paramdef>const char** <parameter>ret</parameter></paramdef>
<paramdef>char** <parameter>ret</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_journal_get_catalog_for_message_id</function></funcdef>
<paramdef>sd_id128_t <parameter>id</parameter></paramdef>
<paramdef>const char** <parameter>ret</parameter></paramdef>
<paramdef>char** <parameter>ret</parameter></paramdef>
</funcprototype>
@ -89,7 +89,7 @@
<function>sd_journal_get_catalog()</function> but the
entry is looked up by the specified message ID (no
open journal context is necessary for this), and no
field substitution is done.</para>
field substitution is performed.</para>
<para>For more information about the journal message
catalog please refer to the <ulink
@ -106,6 +106,11 @@
return 0 on success or a negative errno-style error
code. If no matching message catalog entry is found
-ENOENT is returned.</para>
<para>On successful return, <parameter>ret</parameter>
points to a new string, which must be freed with
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
</para>
</refsect1>
<refsect1>
@ -130,6 +135,7 @@
<citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>
<citerefentry><refentrytitle>malloc</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para>
</refsect1>