Bug 17429: document the --plack/--noplack options of koha-list
authorAndreas Roussos <a.roussos@dataly.gr>
Tue, 29 Dec 2020 09:41:38 +0000 (10:41 +0100)
committerJonathan Druart <jonathan.druart@bugs.koha-community.org>
Tue, 19 Jan 2021 15:03:34 +0000 (16:03 +0100)
The man page of koha-list does not list the --plack and --noplack
options.

This patch fixes that.

Test plan:

1) View the current man page for `koha-list` (with `man koha-list`)
   and notice how the --plack and --noplack options are missing.

2) Apply this patch.

3) Run the following command to re-generate the man page:

   xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
   debian/docs/koha-list.xml

   View the manual page again (with `man -l koha-list.8`), the
   two options are now displayed under SYNOPSIS and OPTIONS.

4) Make sure this test passes:
   prove -v xt/verify-debian-docbook.t

Signed-off-by: Mazen Khallaf <mazen.i.khallaf@gamil.com>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
debian/docs/koha-list.xml

index 1b2129e..828831a 100644 (file)
@@ -27,6 +27,7 @@
       <arg><option>--enabled</option>|<option>--disabled</option></arg>
       <arg><option>--email</option>|<option>--noemail</option></arg>
       <arg><option>--sip</option>|<option>--nosip</option></arg>
+      <arg><option>--plack</option>|<option>--noplack</option></arg>
       <arg><option>-h</option>|<option>--help</option></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
         <para>Only show instances that do not have SIP enabled.</para>
       </listitem>
     </varlistentry>
+    <varlistentry>
+      <term><option>--plack</option></term>
+      <listitem>
+        <para>Only show instances that have Plack enabled.</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><option>--noplack</option></term>
+      <listitem>
+        <para>Only show instances that do not have Plack enabled.</para>
+      </listitem>
+    </varlistentry>
 
     <varlistentry>
       <term><option>-h</option>|<option>--help</option></term>