[Bug 17379] New: Add a man page for koha-passwd
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Bug ID: 17379 Summary: Add a man page for koha-passwd Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: normal Priority: P5 - low Component: Command-line Utilities Assignee: gmcharlt@gmail.com Reporter: magnus@libriotech.no QA Contact: testopia@bugs.koha-community.org CC: robin@catalyst.net.nz The koha-passwd utility was added by bug 13143, but no corresponding man page was added. That should be fixed. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #1 from Lucio Moraes <lmoraes@catalyst.net.nz> --- Created attachment 56740 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=56740&action=edit Bug 17379 - Add a man page for koha-passwd Adding a manpage for the koha-passwd utility. To test: 1) Run these commands and look at the formatted man page: $xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \ debian/docs/koha-passwd.xml 2)$man -l koha-passwd.8 3) Make sure this test passes: $prove -v xt/verify-debian-docbook.t -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Magnus Enger <magnus@libriotech.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff --- Comment #2 from Magnus Enger <magnus@libriotech.no> --- Changing status to "Needs signoff". -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Magnus Enger <magnus@libriotech.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Failed QA --- Comment #3 from Magnus Enger <magnus@libriotech.no> --- The man page looks good, but has a SEE ALSO reference to koha-pass(8). As far as I know, koha-pass is just a Bash alias* made available inside kohadevbox, and does not have a man page? * = See these files for how koha-pass is introduced into kohadevbox: https://github.com/digibib/kohadevbox/blob/master/roles/kohadevbox/tasks/mai... https://github.com/digibib/kohadevbox/blob/master/roles/kohadevbox/templates... -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Lucio Moraes <lmoraes@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |lmoraes@catalyst.net.nz --- Comment #4 from Lucio Moraes <lmoraes@catalyst.net.nz> --- Hi Magnuns I will check. Thank you -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Lucio Moraes <lmoraes@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Lucio Moraes <lmoraes@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #56740|0 |1 is obsolete| | --- Comment #5 from Lucio Moraes <lmoraes@catalyst.net.nz> --- Created attachment 56817 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=56817&action=edit Bug 17379 - Add a man page for koha-passwd Adding a manpage for the koha-passwd utility. To test: 1) Run these commands and look at the formatted man page: $xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \ debian/docs/koha-passwd.xml 2)$man -l koha-passwd.8 3) Make sure this test passes: $prove -v xt/verify-debian-docbook.t Signed-off-by: Your Full Name <your_email> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #6 from Lucio Moraes <lmoraes@catalyst.net.nz> --- I believe i did use the wrong status -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Lucio Moraes <lmoraes@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #56817|0 |1 is obsolete| | --- Comment #7 from Lucio Moraes <lmoraes@catalyst.net.nz> --- Created attachment 56818 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=56818&action=edit Bug 17379 - Add a man page for koha-passwd Adding a manpage for the koha-passwd utility. To test: 1) Run these commands and look at the formatted man page: $xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \ debian/docs/koha-passwd.xml 2)$man -l koha-passwd.8 3) Make sure this test passes: $prove -v xt/verify-debian-docbook.t -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Magnus Enger <magnus@libriotech.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off Patch complexity|--- |Trivial patch -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Magnus Enger <magnus@libriotech.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #56818|0 |1 is obsolete| | --- Comment #8 from Magnus Enger <magnus@libriotech.no> --- Created attachment 56826 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=56826&action=edit Bug 17379 - Add a man page for koha-passwd Adding a manpage for the koha-passwd utility. To test: 1) Run these commands and look at the formatted man page: $xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \ debian/docs/koha-passwd.xml 2)$man -l koha-passwd.8 3) Make sure this test passes: $prove -v xt/verify-debian-docbook.t Signed-off-by: Magnus Enger <magnus@libriotech.no> Man page looks good and covers all functions of the script. Tests pass. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #9 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Comment on attachment 56826 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=56826 Bug 17379 - Add a man page for koha-passwd Review of attachment 56826: --> (https://bugs.koha-community.org/bugzilla3/page.cgi?id=splinter.html&bug=17379&attachment=56826) ----------------------------------------------------------------- ::: debian/docs/koha-passwd.xml @@ +4,5 @@
+ <productname>Koha</productname> is the first free software library automation package. + <author> + <personname> + <firstname>Lucio</firstname> + <surname>Moraes</surname>
I have always thought that the AUTHOR section was for the name of the developer and not the one who wrote the doc. Actually it seems that this section is for both. I'd prefer to see the 2 names: you and Mason (see 78a6f7b0e7). However http://man7.org/linux/man-pages/man7/man-pages.7.html says: "Use of an AUTHORS section is strongly discouraged." So the other possibility is to simply remove it, I do not have a strong opinion. Someone else maybe? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@bugs.koha-c | |ommunity.org, | |tomascohen@gmail.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|gmcharlt@gmail.com |lmoraes@catalyst.net.nz -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #10 from Magnus Enger <magnus@libriotech.no> --- (In reply to Jonathan Druart from comment #9)
"Use of an AUTHORS section is strongly discouraged." So the other possibility is to simply remove it, I do not have a strong opinion.
Someone else maybe?
Running this: grep -A 3 "<author" debian/docs/* shows to varieties. The most common one is: <author> <orgname>The Koha Community</orgname> <uri>http://koha-community.org/</uri> </author> But there are also some where Robin has added his name: <author> <personname> <firstname>Robin</firstname> <surname>Sheat</surname> I would vote for the first one, I think. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #11 from Lucio Moraes <lmoraes@catalyst.net.nz> --- Hi, I think this should be better <author> <orgname>The Koha Community</orgname> <uri>http://koha-community.org/</uri> </author> any thoughts? should I change? thanks -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Lucio Moraes <lmoraes@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #56826|0 |1 is obsolete| | --- Comment #12 from Lucio Moraes <lmoraes@catalyst.net.nz> --- Created attachment 56848 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=56848&action=edit Bug 17379 - Add a man page for koha-passwd Adding a manpage for the koha-passwd utility. To test: 1) Run these commands and look at the formatted man page: $xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \ debian/docs/koha-passwd.xml 2)$man -l koha-passwd.8 3) Make sure this test passes: $prove -v xt/verify-debian-docbook.t -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Severity|normal |enhancement -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Mika <mikasmith@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Mika <mikasmith@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #56848|0 |1 is obsolete| | --- Comment #13 from Mika <mikasmith@catalyst.net.nz> --- Created attachment 57848 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=57848&action=edit Bug 17379 - Add a man page for koha-passwd Adding a manpage for the koha-passwd utility. To test: 1) Run these commands and look at the formatted man page: $xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \ debian/docs/koha-passwd.xml 2)$man -l koha-passwd.8 3) Make sure this test passes: $prove -v xt/verify-debian-docbook.t Signed-off-by: Mika Smith <mikasmith@catalyst.net.nz> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #14 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- The Author part is displayed like: """ AUTHOR Mason James The Koha Community Author """ What is this last "Author" line? (In reply to Jonathan Druart from comment #9)
However http://man7.org/linux/man-pages/man7/man-pages.7.html says: "Use of an AUTHORS section is strongly discouraged."
Still do not want to follow the man page of man? :) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Failed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #15 from Magnus Enger <magnus@libriotech.no> --- Removing the AUTHOR section from all man pages is probably out of scope for the current bug report? We could do that as a separate bug. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #16 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- (In reply to Magnus Enger from comment #15)
Removing the AUTHOR section from all man pages is probably out of scope for the current bug report? We could do that as a separate bug.
Absolutely not what I asked, just waiting for 1 line removal. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Mason James <mtj@kohaaloha.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #17 from Mason James <mtj@kohaaloha.com> --- Created attachment 140815 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=140815&action=edit Bug 17379: Add a man page for koha-passwd (2) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Mason James <mtj@kohaaloha.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |mtj@kohaaloha.com --- Comment #18 from Mason James <mtj@kohaaloha.com> --- (In reply to Jonathan Druart from comment #16)
(In reply to Magnus Enger from comment #15)
Removing the AUTHOR section from all man pages is probably out of scope for the current bug report? We could do that as a separate bug.
Absolutely not what I asked, just waiting for 1 line removal.
hi Jonathan, i've made the 1 line removal. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #140815|0 |1 is obsolete| | --- Comment #19 from David Nind <david@davidnind.com> --- Created attachment 140838 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=140838&action=edit Bug 17379: Add a man page for koha-passwd (2) Signed-off-by: David Nind <david@davidnind.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |david@davidnind.com --- Comment #20 from David Nind <david@davidnind.com> --- Testing notes (using KTD): 1. For whatever reason, the man page software is not installed in KTD (see https://gitlab.com/koha-community/koha-testing-docker/-/issues/155). Installed with: apt-get install man-db 2. man koha-passwd ==> No manual entry for koha-passwd 3. Apply the patches. 4. I tried to follow the test plan, but was not able to update the man page output (see note below). 5. I reviewed the source file (debian/docs/koha-passwd.xml) and can confirm that the required change was made. 6. Have signed off, as I'm assuming that the build process will take care of correctly producing the man pages once the change is pushed to master. Note: I'm not sure that the steps in the test plan to produce the man page is correct - they didn't work for me anyway. I tried shutting down KTD, restarting, and apt-get install man-db again - flush_memcached and restart_all wasn't sufficient, and even then it outputted the "old" man page without the author line removed. See steps 5 and 6. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- QA Contact|testopia@bugs.koha-communit |katrin.fischer@bsz-bw.de |y.org | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #21 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I also installed apt-get install man-db. And I did a reset_all in hope that the files would get copied to the right place. Also did a man koha-common. I am not sure what worked :( But: man koha-passwd now shows the help for me. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #57848|0 |1 is obsolete| | Attachment #140838|0 |1 is obsolete| | --- Comment #22 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 141540 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=141540&action=edit Bug 17379: Add a man page for koha-passwd Adding a manpage for the koha-passwd utility. To test: 1) Run these commands and look at the formatted man page: $xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \ debian/docs/koha-passwd.xml 2)$man -l koha-passwd.8 3) Make sure this test passes: $prove -v xt/verify-debian-docbook.t Signed-off-by: Mika Smith <mikasmith@catalyst.net.nz> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #23 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 141541 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=141541&action=edit Bug 17379: Add a man page for koha-passwd (2) Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)| |22.11.00 released in| | Status|Passed QA |Pushed to master -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 --- Comment #24 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Pushed to master for 22.11. Nice work everyone, thanks! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17379 Lucas Gass <lucas@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to master |RESOLVED CC| |lucas@bywatersolutions.com Resolution|--- |FIXED -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org