[Bug 4877] New: koha-* scripts have no manual pages
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Summary: koha-* scripts have no manual pages Change sponsored?: --- Product: Koha Version: rel_3_2 Platform: All OS/Version: All Status: NEW Severity: enhancement Priority: P5 Component: Packaging AssignedTo: lars@catalyst.net.nz ReportedBy: lars@catalyst.net.nz QAContact: koha-bugs@lists.koha-community.org Estimated Hours: 0.0 The Debian packaging contains scripts in debian/scripts. Most of those scripts do not have manual pages. Since they are generally useful command line tools for Koha instances, they should have manual page. There is one page, for koha-create, which could be used as a basis for the others. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Lars Wirzenius <lars@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- AssignedTo|lars@catalyst.net.nz |robin@catalyst.net.nz -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |2509 -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #1 from Magnus Enger <magnus@enger.priv.no> 2011-08-28 13:06:27 UTC --- Created attachment 5184 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=5184 Proposed patch, updating the manual page for koha-create This patch is an update for the already existing manual page for koha-create. It's my first attempt at editing a manual page, so please don't be kind to it. The best trick I have found for viewing it is: nroff -man debian/scripts/koha-create.8 | less Note: All the other commands provided by koha-common still lack manual pages, and there should probably be one for koha-common itself too. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Priority|P5 |PATCH-Sent CC| |magnus@enger.priv.no Patch Status|--- |Needs Signoff AssignedTo|robin@catalyst.net.nz |magnus@enger.priv.no -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #2 from Robin Sheat <robin@catalyst.net.nz> 2011-08-29 00:23:59 UTC --- Created attachment 5196 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=5196 Bug 4877 - Update man page for koha-create Signed-off-by: Robin Sheat <robin@catalyst.net.nz> (to be followed by another patch that I think helps too) -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #3 from Robin Sheat <robin@catalyst.net.nz> 2011-08-29 00:25:23 UTC --- Created attachment 5197 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=5197 Bug 4877 - more man page improvements -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |robin@catalyst.net.nz --- Comment #4 from Robin Sheat <robin@catalyst.net.nz> 2011-08-29 00:28:44 UTC --- It's a good start, and I made a few additions that I think should help it. BTW, 'man -l koha-create.8' is what I use to view it. If you can mark this as signed off (assuming that's correct :) so that the patches go in, but when they actually do go through , we should remove the patch-sent status, so it remains open for the other pages. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #5184|0 |1 is obsolete| | -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #5197|0 |1 is obsolete| | --- Comment #5 from Magnus Enger <magnus@enger.priv.no> 2011-08-29 07:11:22 UTC --- Created attachment 5205 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=5205 Signed off Robin's followup patch Signing off on Robin's patch. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch Status|Needs Signoff |Signed Off -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Chris Cormack <chris@bigballofwax.co.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |chris@bigballofwax.co.nz Patch Status|Signed Off |Patch Pushed --- Comment #6 from Chris Cormack <chris@bigballofwax.co.nz> 2011-09-04 08:24:42 UTC --- Man pages for scripts provided by packages, pushed please test -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Priority|PATCH-Sent |P1 Patch Status|Patch Pushed |--- --- Comment #7 from Robin Sheat <robin@catalyst.net.nz> 2011-09-05 00:09:12 UTC --- Looks good. Going to reset the status on this and mark the pushed stuff as obsolete so that it remains a place for any other ones we make. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #5196|0 |1 is obsolete| | -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #5205|0 |1 is obsolete| | -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |nengard@gmail.com --- Comment #8 from Magnus Enger <magnus@enger.priv.no> 2011-09-09 22:43:07 UTC --- Editing the man page for koha-create directly was a less than pleasant experience. I'd like to propose that we maintain man pages in DocBook format and transform them to other formats as necessary. See http://wiki.koha-community.org/wiki/Maintaining_man_pages_for_koha-common_as... for details. I'm adding Nicole on the CC list, since having the opinion of the Documentation Manager on this feels appropriate. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #9 from Nicole C. Engard <nengard@gmail.com> 2011-09-09 22:52:24 UTC --- What the heck is a man page? -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #10 from Magnus Enger <magnus@enger.priv.no> 2011-09-09 22:56:51 UTC --- (In reply to comment #9)
What the heck is a man page?
It's what you see when you type "man somecommand" on the commandline. See e.g. http://en.wikipedia.org/wiki/Man_pages :-) -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #11 from Robin Sheat <robin@catalyst.net.nz> 2011-09-10 14:02:09 UTC --- I'm completely in favour of doing it as docbook, it'll make many things easier. I'm not sure that having one file for all of them is the way to go though, I don't think it'll gain us anything useful, but will cost us a bit of clarity when it comes to having people edit them. I think generating them as part of the package build is the way to go. We can use a similar kind of process to generate them for the website should we want to (e.g. every week grab the latest copy from the repo and generate the HTML for it.) Minimising the manual processing needed will ensure that they're always as up to date as possible. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #12 from Magnus Enger <magnus@enger.priv.no> 2011-09-10 14:05:14 UTC --- Sounds good to me. Where should we put the XML files? I can split up my "big" file and do an initial patch. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #13 from Robin Sheat <robin@catalyst.net.nz> 2011-09-11 01:56:02 UTC --- Maybe make a debian/docs directory and put them in there? -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #14 from Magnus Enger <magnus@enger.priv.no> 2011-09-13 06:34:21 UTC --- Created attachment 5413 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=5413 Proposed patch This patch - deletes debian/scripts/koha-create.8 - adds debian/docs/koha-create.xml and koha-remove.xml To test: Check that something like this: xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl koha-*.xml produces sensible output. The output from koha-create.xml should be very similar to the old koha-create.8. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Priority|P1 |PATCH-Sent Patch Status|--- |Needs Signoff -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #15 from Robin Sheat <robin@catalyst.net.nz> 2011-09-13 23:22:57 UTC --- It doesn't add the command to build the man page to the build rules which is something I'd like to have before it's signed off. Other notes (for dependencies when packaging): * xsltproc is provided by the package xsltproc * /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl is provided by docbook-xsl I looked into using docbook-to-man, because (name-wise) it seems ideal for this, however that seems to have not been maintained since 1996 when docbook was just SGML, so I think the xsltproc method is the way to go here. Finally, the man output appears exactly as I'd expect, so no quibbles there :) -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #16 from Magnus Enger <magnus@enger.priv.no> 2011-09-14 06:30:39 UTC --- I'll see what I can do, but if anyone wants to beat me to it, feel free... ;-) -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Version|rel_3_2 |master Patch Status|Needs Signoff |--- --- Comment #17 from Robin Sheat <robin@catalyst.net.nz> 2011-09-14 06:48:59 UTC --- I might take a bit of a look -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #18 from Robin Sheat <robin@catalyst.net.nz> 2011-09-15 05:59:06 UTC --- Created attachment 5433 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=5433 Bug 4877 - install generated man pages with build process This uses the docbook source files to generate the man pages, and installs them to their correct location when the packages are being built. This will make it easier for people to write man pages, thereby ensuring that people join in keeping documentation up to date. Note: adds docbook-xsl and xsltproc to the dependencies. Note2: applies on top of Magnus' other patch on this ticket. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #19 from Robin Sheat <robin@catalyst.net.nz> 2011-09-15 06:00:07 UTC --- Created attachment 5434 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=5434 Bug 4877 [ENH] Use DocBook for koha-common manual pages This patch - deletes debian/scripts/koha-create.8 - adds debian/docs/koha-create.xml and koha-remove.xml Signed-off-by: Robin Sheat <robin@catalyst.net.nz> -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch Status|--- |Needs Signoff -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #5413|0 |1 is obsolete| | -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #5433|0 |1 is obsolete| | --- Comment #20 from Magnus Enger <magnus@enger.priv.no> 2011-09-15 09:55:08 UTC --- Created attachment 5435 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=5435 Signed off Robin's followup patch - Applied Robin's patch on a branch off current master - Built packages with build-git-snapshot - Installed koha-common on a fresh VM - "man koha-create" and "man koha-remove" produced the expected output. Signing off! -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch Status|Needs Signoff |Signed Off --- Comment #21 from Magnus Enger <magnus@enger.priv.no> 2011-09-15 09:56:59 UTC --- If these two patches get pushed, status should be reset - there are lots more manual pages that need to be created. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Chris Cormack <chris@bigballofwax.co.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Priority|PATCH-Sent |P4 Patch Status|Signed Off |--- --- Comment #22 from Chris Cormack <chris@bigballofwax.co.nz> 2011-09-16 01:53:53 UTC --- Pushed, and status reset -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #23 from Robin Sheat <robin@catalyst.net.nz> 2011-09-22 02:38:43 UTC --- Created attachment 5527 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=5527 Bug 4877 - note that the create-db (or related) options are required Also fix the example so that it is there. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Priority|P4 |PATCH-Sent Patch Status|--- |Needs Signoff Summary|koha-* scripts have no |Create and update the |manual pages |manual pages for the koha-* | |scripts. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Ian Walls <ian.walls@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |ian.walls@bywatersolutions. | |com Patch Status|Needs Signoff |Passed QA --- Comment #24 from Ian Walls <ian.walls@bywatersolutions.com> 2011-09-22 12:03:19 UTC --- Marking latest patch as both signed off and passed QA, since it's an XML-only change (adding an attribute and changing some text, neither of which is likely to cause any kind of regression) -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Chris Cormack <chris@bigballofwax.co.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #5527|0 |1 is obsolete| | -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Chris Cormack <chris@bigballofwax.co.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #5435|0 |1 is obsolete| | -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Chris Cormack <chris@bigballofwax.co.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #5434|0 |1 is obsolete| | -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Chris Cormack <chris@bigballofwax.co.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch Status|Passed QA |Patch Pushed --- Comment #25 from Chris Cormack <chris@bigballofwax.co.nz> 2011-09-23 03:14:18 UTC --- Pushed -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Priority|PATCH-Sent |P3 Patch Status|Patch Pushed |--- -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #26 from Magnus Enger <magnus@enger.priv.no> 2011-09-26 08:16:17 UTC --- I turned http://wiki.koha-community.org/wiki/Commands_provided_by_the_Debian_packages into a CSV file and with a small script and a couple of templates turned that into DocBook files and .8 files. The results can be seen here: https://github.com/MagnusEnger/kohaman The XML files are in the output/ folder, .8 files created from the XML are in the manpages/ folder. I have also created koha-common.xml, which lists all the commands provided by the packages. I'll submit a proper patch for this of course, but if anyone can spot general changes that should be made to all the files, now would be a good time. I'll wait a few days before I submit the patch. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #27 from Magnus Enger <magnus@enger.priv.no> 2011-10-17 10:26:26 UTC --- Created attachment 5920 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=5920 Bug 4877 - Add DocBook for missing manual pages Add DocBook manual pages for commands that do not have a manual page yet. Also add a page for koha-common itself, listing all the available commands. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Priority|P3 |PATCH-Sent Patch Status|--- |Needs Signoff -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #28 from Magnus Enger <magnus@enger.priv.no> 2011-10-19 14:31:28 UTC --- * To test that latest patch: - build packages with build-git-snapshot - install koha-common - check that "man <command>" produces sensible output for every command installed by koha-common * Alternate test plan: Check that these provide sensible output: 1. Generate manual pages (*.8 files) $ cd debian/docs $ xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl koha-*.xml View generated pages with e.g. "man -l koha-remove.8" 2. Generate HTML $ xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/xhtml/docbook.xsl koha-*.xml > koha-common.html view koha-common.html in a browser. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #29 from Robin Sheat <robin@catalyst.net.nz> 2011-10-20 06:32:30 UTC --- Created attachment 6003 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=6003 Bug 4877 - Add DocBook for missing manual pages Add DocBook manual pages for commands that do not have a manual page yet. Also add a page for koha-common itself, listing all the available commands. Signed-off-by: Robin Sheat <robin@catalyst.net.nz> Minor change: I fixed a typo I spotted -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #5920|0 |1 is obsolete| | -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch Status|Needs Signoff |Signed Off --- Comment #30 from Robin Sheat <robin@catalyst.net.nz> 2011-10-20 06:34:01 UTC --- Please remove the patch-sent and signed-off statuses when this is applied, there's still more stuff to do with these. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Paul Poulain <paul.poulain@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version|master |Rel_3_8 --- Comment #31 from Paul Poulain <paul.poulain@biblibre.com> 2011-10-24 11:40:14 UTC --- Updating version : This ENH could be in Koha 3.8 -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Paul Poulain <paul.poulain@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version|Rel_3_8 |master --- Comment #32 from Paul Poulain <paul.poulain@biblibre.com> 2011-10-25 15:05:49 UTC --- Bug versionned for master. entries will be made against rel_3_8 once the patch has been applied (see thread about that on koha-devel yesterday) -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #33 from Chris Nighswonger <cnighswonger@foundations.edu> 2011-10-26 18:02:20 UTC --- The fix for this bug was published in the 3.4.5 release. If you were the reporter of this bug, please take time to verify the fix and update the status of this bug report accordingly. If the bug is fixed to your satisfaction, please close this report. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #34 from Magnus Enger <magnus@enger.priv.no> 2011-10-26 18:20:35 UTC --- The latest patch here is only signed off and has not been pushed yet. Please don't close until it has been pushed. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Ian Walls <ian.walls@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch Status|Signed Off |Passed QA --- Comment #35 from Ian Walls <ian.walls@bywatersolutions.com> 2011-11-19 15:54:42 UTC --- Creates a bunch of XML files; while I cannot verify with 100% certainty that the content is correct, I can verify that the documentation does not lead to any regressions anywhere else in the system. Marking as Passed QA. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Paul Poulain <paul.poulain@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |ASSIGNED CC| |paul.poulain@biblibre.com Version|master |rel_3_8 Patch Status|Passed QA |Patch Pushed --- Comment #36 from Paul Poulain <paul.poulain@biblibre.com> 2011-11-24 09:37:17 UTC --- Patch pushed, please test I played with the xslt as explained by magnus. I get a warning: WARNING: cannot add @xml:base to node set root element. Relative paths may not work. man -l xxx.8 works fine though, so pushing attachment 6003. Please test, and, if there are still missing, remove the patch pushed -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Paul Poulain <paul.poulain@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #6003|0 |1 is obsolete| | --- Comment #37 from Paul Poulain <paul.poulain@biblibre.com> 2011-11-24 09:54:40 UTC --- Comment on attachment 6003 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=6003 Bug 4877 - Add DocBook for missing manual pages this patch has been pushed -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 --- Comment #38 from Robin Sheat <robin@catalyst.net.nz> 2011-11-24 10:10:10 UTC --- The warning is ok, not exactly sure what causes it, but it doesn't adversely effect anything. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Priority|PATCH-Sent |P3 Severity|enhancement |normal --- Comment #39 from Magnus Enger <magnus@enger.priv.no> 2012-01-10 17:11:28 UTC --- The manual pages work in current master, but I can't find a manual page for koha-run-backups, so I'm resetting the status of this bug. -- Configure bugmail: http://bugs.koha-community.org/bugzilla3/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the QA Contact for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Jared Camins-Esakov <jcamins@cpbibliography.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to Master |ASSIGNED -- You are receiving this mail because: You are the QA Contact for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=4877 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |RESOLVED Resolution|--- |FIXED --- Comment #40 from Magnus Enger <magnus@enger.priv.no> --- (In reply to comment #39)
The manual pages work in current master, but I can't find a manual page for koha-run-backups, so I'm resetting the status of this bug.
This is addressed by my patch for Bug 8568, so I'm marking this one as RESOLVED FIXED. -- You are receiving this mail because: You are the QA Contact for the bug. You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org