From: Lennart Poettering <lennart@poettering.net>
Date: Mon, 25 May 2020 17:39:50 +0000 (+0200)
Subject: man: briefly document the DOCUMENTATION= structure log field
X-Git-Tag: v246-rc1~237^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dd587c3a881ad695031c01eb825e7371747d5a53;p=thirdparty%2Fsystemd.git

man: briefly document the DOCUMENTATION= structure log field
---

diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml
index 4d35cfb6dc5..31ad143113c 100644
--- a/man/systemd.journal-fields.xml
+++ b/man/systemd.journal-fields.xml
@@ -139,6 +139,16 @@
           </para>
         </listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><varname>DOCUMENTATION=</varname></term>
+        <listitem>
+          <para>A documentation URL with further information about the topic of the log message. Tools such
+          as <command>journalctl</command> will include a hyperlink to an URL specified this way in their
+          output. Should be a <literal>http://</literal>, <literal>https://</literal>,
+          <literal>file:/</literal>, <literal>man:</literal> or <literal>info:</literal> URL.</para>
+        </listitem>
+      </varlistentry>
     </variablelist>
   </refsect1>