Bug 8568 - Fix some errors in docs for scripts provided by the Debian packages
Summary: Fix some errors in docs for scripts provided by the Debian packages
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 3.8
Hardware: All All
: P5 - low minor (vote)
Assignee: Magnus Enger
QA Contact: Paul Poulain
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-08-03 10:00 UTC by Magnus Enger
Modified: 2013-12-05 20:01 UTC (History)
4 users (show)

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


Attachments
Bug 8568 - Fix some errors in docs for scripts provided by the Debian packages (4.87 KB, patch)
2012-09-30 08:02 UTC, Magnus Enger
Details | Diff | Splinter Review
Bug 8568 - Fix some errors in docs for scripts provided by the Debian packages (5.14 KB, patch)
2012-10-04 16:51 UTC, Frédéric Demians
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-08-03 10:00:43 UTC
1. debian/docs/koha-common.xml does not list koha-create

2. debian/docs/koha-common.xml does list koha-remove, but on one system I tested it was not displayed, this needs some more investigation

3. debian/docs/koha-foreach.xml uses koha-list in the synopsis of the command. The arguments are the same, but doh...
Comment 1 Magnus Enger 2012-09-29 16:20:29 UTC
4. koha-run-backups does not have a man page
Comment 2 Magnus Enger 2012-09-30 08:02:01 UTC Comment hidden (obsolete)
Comment 3 Magnus Enger 2012-09-30 08:03:48 UTC
I could not recreate issue 2 above, with the missing man page for koha-remove, so the attached patch is for issues 1, 3 and 4.
Comment 4 Frédéric Demians 2012-10-04 16:51:51 UTC
Created attachment 12688 [details] [review]
Bug 8568 - Fix some errors in docs for scripts provided by the Debian packages

1. Create a page for koha-run-backups
2. Fix the synopsis for koha-foreach
3. Add koha-create and koha-run-backups to koha-common

To test
- Convert the changed xml files to man pages with
$ xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl koha-x.xml
- View generated pages with e.g.
$ man -l koha-x.8"
  (Replace x with the names of the changed files)
- Check that the changes make sense

Signed-off-by: Frédéric Demians <f.demians@tamil.fr>

Works as described. I was able to produce the 3 man files, load them with man
command, and see the added information properly formated.
Comment 5 Paul Poulain 2012-10-24 16:18:31 UTC
QA comment: doc only patch, passed QA
Comment 6 Paul Poulain 2012-10-24 16:19:58 UTC
Patch pushed to master
Comment 7 Chris Cormack 2012-10-24 20:24:28 UTC
Pushed to 3.8.x, will be in 3.8.7
Comment 8 Magnus Enger 2012-11-28 19:10:28 UTC
Works with 3.10.