Bug 9247 - Add two more usage examples to the manpage for koha-mysql
Summary: Add two more usage examples to the manpage for koha-mysql
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement
Assignee: Magnus Enger
QA Contact:
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-12-09 12:53 UTC by Magnus Enger
Modified: 2014-12-07 20:02 UTC (History)
4 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Trivial patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments
Bug 9247 - Add two more usage examples to the manpage for koha-mysql (2.55 KB, patch)
2013-07-30 13:46 UTC, Magnus Enger
Details | Diff | Splinter Review
Bug 9247 - Add two more usage examples to the manpage for koha-mysql (2.60 KB, patch)
2013-08-08 19:25 UTC, Mirko Tietgen
Details | Diff | Splinter Review
[PASSED QA] Bug 9247 - Add two more usage examples to the manpage for koha-mysql (2.71 KB, patch)
2013-08-27 20:27 UTC, Katrin Fischer
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Magnus Enger 2012-12-09 12:53:42 UTC
Specifically, these:

echo "some SQL" | sudo koha-mysql <instance>

sudo koha-mysql <instance> < somefile.sql

I tend to forget the exact syntax, at least for the first one, so having them in the manpage would be nice.
Comment 1 Magnus Enger 2013-07-30 13:46:16 UTC Comment hidden (obsolete)
Comment 2 Mirko Tietgen 2013-08-08 19:25:18 UTC Comment hidden (obsolete)
Comment 3 Katrin Fischer 2013-08-27 20:27:01 UTC
Created attachment 20665 [details] [review]
[PASSED QA] Bug 9247 - Add two more usage examples to the manpage for koha-mysql

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.
Comment 4 Galen Charlton 2013-08-28 13:43:26 UTC
Pushed to master.  Thanks, Magnus!
Comment 5 Tomás Cohen Arazi (tcohen) 2013-09-13 17:28:29 UTC
This patch has been pushed to 3.12.x, will be in 3.12.5.

Thanks Magnus!
Comment 6 Bernardo Gonzalez Kriegel 2013-10-13 13:23:44 UTC
Pushed to 3.10.x, will be in 3.10.12