diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2013-03-15 18:10:51 -0400 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2013-03-19 21:50:42 -0400 |
| commit | 0d1aaec2282ee8e82908f9f12d820dab397adc0b (patch) | |
| tree | a49bf1a42e433774618a9e61a9c98f4b7b7235f5 | |
| parent | 6531dac67cc2e707e4a2b62f3ae11f7330f7c049 (diff) | |
man/catalog: fix synopsis and remind to free
| -rw-r--r-- | man/sd_journal_get_catalog.xml | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/man/sd_journal_get_catalog.xml b/man/sd_journal_get_catalog.xml index b3c7b58b07..719d77f723 100644 --- a/man/sd_journal_get_catalog.xml +++ b/man/sd_journal_get_catalog.xml @@ -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> |