The koha-passwd utility was added by bug 13143, but no corresponding man page was added. That should be fixed.
Created attachment 56740 [details] [review] 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
Changing status to "Needs signoff".
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/main.yml#L75 https://github.com/digibib/kohadevbox/blob/master/roles/kohadevbox/templates/bash_aliases.j2#L10
Hi Magnuns I will check. Thank you
Created attachment 56817 [details] [review] 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>
I believe i did use the wrong status
Created attachment 56818 [details] [review] 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
Created attachment 56826 [details] [review] 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.
Comment on attachment 56826 [details] [review] Bug 17379 - Add a man page for koha-passwd Review of attachment 56826 [details] [review]: ----------------------------------------------------------------- ::: 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?
(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.
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
Created attachment 56848 [details] [review] 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
Created attachment 57848 [details] [review] 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>
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? :)
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.
(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.
Created attachment 140815 [details] [review] Bug 17379: Add a man page for koha-passwd (2)
(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.
Created attachment 140838 [details] [review] Bug 17379: Add a man page for koha-passwd (2) Signed-off-by: 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.
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.
Created attachment 141540 [details] [review] 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>
Created attachment 141541 [details] [review] 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>
Pushed to master for 22.11. Nice work everyone, thanks!