Attachment 20665 Details for Bug 9247 – [PASSED QA] Bug 9247 - Add two more usage examples to the manpage for koha-mysql

[patch] [PASSED QA] Bug 9247 - Add two more usage examples to the manpage for koha-mysql

PASSED-QA-Bug-9247---Add-two-more-usage-examples-t.patch (text/plain), 2.71 KB, created by Katrin Fischer on 2013-08-27 20:27:01 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Katrin Fischer

Created: 2013-08-27 20:27:01 UTC

Size: 2.71 KB

patch

obsolete

>From 5a91c944c8eee80b63ae83ed8d038ad195e45a27 Mon Sep 17 00:00:00 2001
>From: Magnus Enger <magnus@enger.priv.no>
>Date: Tue, 30 Jul 2013 15:32:31 +0200
>Subject: [PATCH] [PASSED QA] Bug 9247 - Add two more usage examples to the
> manpage for koha-mysql
>MIME-Version: 1.0
>Content-Type: text/plain; charset=UTF-8
>Content-Transfer-Encoding: 8bit
>
>It might not be immediately obvious that it is possible to send
>SQL queries "directly" to the koha-mysql command, or that files
>from mysqldump can be loaded with it. This patch adds these as
>"example usage" to the man page for koha-mysql.
>
>To test:
>
>Run these commands and look at the formatted man page:
>$Â xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
>  debian/docs/koha-mysql.xml
>$Â man -l koha-mysql.8
>
>Make sure this test passes:
>$Â prove -v xt/verify-debian-docbook.t
>
>This patch also corrects a couple places where "Koha" was written as "koha".
>
>Signed-off-by: Mirko Tietgen <mirko@abunchofthings.net>
>Signed-off-by: Katrin Fischer <Katrin.Fischer.83@web.de>
>Test plan, all tests and QA script pass.
>---
> debian/docs/koha-mysql.xml |   21 +++++++++++++++++++--
> 1 file changed, 19 insertions(+), 2 deletions(-)
>
>diff --git a/debian/docs/koha-mysql.xml b/debian/docs/koha-mysql.xml
>index 070deb6..80020a3 100644
>--- a/debian/docs/koha-mysql.xml
>+++ b/debian/docs/koha-mysql.xml
>@@ -17,7 +17,7 @@
> 
>   <refnamediv>
>     <refname>koha-mysql</refname>
>-    <refpurpose>Provide an interactive mysql shell set up for the specified koha instance.</refpurpose>
>+    <refpurpose>Provide an interactive mysql shell set up for the specified Koha instance.</refpurpose>
>     <refclass>UNIX/Linux</refclass>
>   </refnamediv>
> 
>@@ -28,7 +28,24 @@
>   </refsynopsisdiv>
> 
>   <refsect1><title>Description</title>
>-  <para>Provide an interactive mysql shell set up for the specified koha instance.</para>
>+  <para>Provide an interactive mysql shell set up for the specified Koha instance.</para>
>+  </refsect1>
>+
>+  <refsect1><title>Example usage</title>
>+    <variablelist>
>+      <varlistentry>
>+        <term>Send an SQL query to MySQL</term>
>+        <listitem>
>+          <para>"Some SQL query" | <command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg></para>
>+        </listitem>
>+      </varlistentry>
>+      <varlistentry>
>+        <term>Load a database dump (e.g. one produced by mysqldump) into the database of the given instance</term>
>+        <listitem>
>+          <para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> &lt; /path/to/mysqldump.sql</para>
>+        </listitem>
>+      </varlistentry>
>+    </variablelist>
>   </refsect1>
>   
>   <refsect1><title>See also</title>
>-- 
>1.7.9.5

Actions: View | Diff | Splinter Review

Attachments on bug 9247: 19988 | 20188 | 20665