[Bug 37538] New: Improve documentation of connexion_import_daemon.pl
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Bug ID: 37538 Summary: Improve documentation of connexion_import_daemon.pl Change sponsored?: --- Product: Koha Version: Main Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Command-line Utilities Assignee: koha-bugs@lists.koha-community.org Reporter: rudolfbyker@gmail.com QA Contact: testopia@bugs.koha-community.org CC: robin@catalyst.net.nz Patch incoming :) See related discussions at: - https://chat.koha-community.org/koha-community/pl/o18q57a1pt879dgp63ujtcajpe - https://chat.koha-community.org/koha-community/pl/gz3mjusns3bdme3j4f8sp83sfw - https://chat.koha-community.org/koha-community/pl/yzxmrfegcbnrjgqgjt7t6wjwhy I plan to follow this up with a patch for the koha-manual, which I will also link here. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Rudolf Byker <rudolfbyker@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |rudolfbyker@gmail.com |ity.org | CC| |rudolfbyker@gmail.com Status|NEW |Needs Signoff --- Comment #1 from Rudolf Byker <rudolfbyker@gmail.com> --- Created attachment 169894 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=169894&action=edit Improve output of `connexion_import_daemon.pl --help` Patch attached. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Rudolf Byker <rudolfbyker@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Change sponsored?|--- |Sponsored Patch complexity|--- |String patch -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Rudolf Byker <rudolfbyker@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|Improve documentation of |Improve documentation |connexion_import_daemon.pl |printed by | |connexion_import_daemon.pl | |--help -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Rudolf Byker <rudolfbyker@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |37539 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37539 [Bug 37539] Improve the documentation for the OCLC Connexion Daemon / Gateway in the manual -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 David Cook <dcook@prosentient.com.au> 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=37538 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #169894|0 |1 is obsolete| | --- Comment #2 from David Cook <dcook@prosentient.com.au> --- Created attachment 169921 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=169921&action=edit Bug 37538: Improve documentation for the OCLC import daemon script. To test: 1) Run `/usr/share/koha/bin/connexion_import_daemon.pl --help` 2) Read the output and check for errors, whether grammatical, spelling, or factual. Sponsored-by: Reformational Study Centre <www.refstudycentre.com> Signed-off-by: David Cook <dcook@prosentient.com.au> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |dcook@prosentient.com.au --- Comment #3 from David Cook <dcook@prosentient.com.au> --- Patch works as described. Test plan should use "./misc/bin/connexion_import_daemon.pl --help" rather than "/usr/share/koha/bin/connexion_import_daemon.pl --help" but not a problem I'm not sure that the format is quite inline with other Koha scripts... but it looks like a very useful change. I haven't verified the truth of all the text changes, but they look good at a glance, and much more helpful than the current help text. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 --- Comment #4 from Rudolf Byker <rudolfbyker@gmail.com> --- I'm not sure what you mean by the format not being in line with other scripts. I'm willing to improve it. I'm also willing to just let it go, and eager to get it merged, so that I can refer users to the script's --help output from the manual. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 --- Comment #5 from David Cook <dcook@prosentient.com.au> --- (In reply to Rudolf Byker from comment #4)
I'm not sure what you mean by the format not being in line with other scripts.
Say in comparison to the scripts in /usr/sbin/koha-*
I'm willing to improve it. I'm also willing to just let it go, and eager to get it merged, so that I can refer users to the script's --help output from the manual.
I think that we can just let it go. Honestly, I don't think I have any specific recommendations on how to improve it either. A QAer might have some thoughts on this one, but with a script like this which is so rarely used... I think the more documentation the better in any case. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |david@davidnind.com Resolution|--- |FIXED Status|Signed Off |RESOLVED -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Resolution|FIXED |--- Status|RESOLVED |REOPENED -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|REOPENED |Needs documenting -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 --- Comment #6 from David Nind <david@davidnind.com> --- I changed the status to "Needs documenting". Because of the way the Koha workflow is set up in Bugzilla (aimed at changes to the Koha code base), I needed to change the status a few times to get the right status shown: 1. RESOLVED FIXED 2. REOPENED 3. Needs documenting The status can be changed to RESOLVED FIXED once the merge request goes through. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 --- Comment #7 from David Cook <dcook@prosentient.com.au> --- (In reply to David Nind from comment #6)
I changed the status to "Needs documenting".
The status can be changed to RESOLVED FIXED once the merge request goes through.
What needs documenting for this one? Is it just for the release notes or something else? this change shouldn't affect the manual? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs documenting |RESOLVED Resolution|--- |FIXED --- Comment #8 from David Nind <david@davidnind.com> --- (In reply to David Cook from comment #7)
(In reply to David Nind from comment #6)
I changed the status to "Needs documenting".
The status can be changed to RESOLVED FIXED once the merge request goes through.
What needs documenting for this one? Is it just for the release notes or something else? this change shouldn't affect the manual?
OOPS, I updated the wrong bug! (Should have been bug 37539!) Thanks for spotting, David. Have changed back to Signed Off.... -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Resolution|FIXED |--- Status|RESOLVED |REOPENED -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|REOPENED |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 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=37538 Lisette Scheer <lisette@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |lisette@bywatersolutions.co | |m QA Contact|testopia@bugs.koha-communit |lisette@bywatersolutions.co |y.org |m -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Lisette Scheer <lisette@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Patch doesn't apply --- Comment #9 from Lisette Scheer <lisette@bywatersolutions.com> --- Patch failed to apply. Please rebase. M misc/bin/connexion_import_daemon.pl Falling back to patching base and 3-way merge... Auto-merging misc/bin/connexion_import_daemon.pl CONFLICT (content): Merge conflict in misc/bin/connexion_import_daemon.pl error: Failed to merge in the changes. Patch failed at 0001 Bug 37538: Improve documentation for the OCLC import daemon script. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Rudolf Byker <rudolfbyker@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #169921|0 |1 is obsolete| | --- Comment #10 from Rudolf Byker <rudolfbyker@gmail.com> --- Created attachment 187431 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=187431&action=edit Improve documentation for the OCLC import daemon script. Rebased :) Sorry for leaving this hanging for so long. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Patch doesn't apply |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 --- Comment #11 from David Nind <david@davidnind.com> --- Created attachment 187434 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=187434&action=edit Bug 37538: Improve documentation for the OCLC import daemon script. This updates the documentation for the misc/bin/connexion_import_daemon.pl --help option. Test plan: 1. Run ./misc/bin/connexion_import_daemon.pl --help 2. Read the output and check for errors, whether grammatical, spelling, or factual. Sponsored-by: Reformational Study Centre <www.refstudycentre.com> Signed-off-by: David Cook <dcook@prosentient.com.au> 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=37538 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #187431|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 --- Comment #12 from David Nind <david@davidnind.com> --- Created attachment 187435 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=187435&action=edit Bug 37538: Improve documentation for the OCLC import daemon script This updates the documentation for the misc/bin/connexion_import_daemon.pl --help option. Test plan: 1. Run ./misc/bin/connexion_import_daemon.pl --help 2. Read the output and check for errors, whether grammatical, spelling, or factual. Sponsored-by: Reformational Study Centre <www.refstudycentre.com> Signed-off-by: David Cook <dcook@prosentient.com.au> 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=37538 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #187434|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 --- Comment #13 from David Nind <david@davidnind.com> --- I've signed off. I've tidied up the patch a little, but haven't tested the options for the commands: 1. Terminology: intranet to staff interface 2. Terminology: e.g. to for example 3. Terminology: i.e. to that is 4. Line length to 79/80 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Lisette Scheer <lisette@bywatersolutions.com> 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=37538 Lisette Scheer <lisette@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #187435|0 |1 is obsolete| | --- Comment #14 from Lisette Scheer <lisette@bywatersolutions.com> --- Created attachment 189378 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=189378&action=edit Bug 37538: Improve documentation for the OCLC import daemon script This updates the documentation for the misc/bin/connexion_import_daemon.pl --help option. Test plan: 1. Run ./misc/bin/connexion_import_daemon.pl --help 2. Read the output and check for errors, whether grammatical, spelling, or factual. Sponsored-by: Reformational Study Centre <www.refstudycentre.com> Signed-off-by: David Cook <dcook@prosentient.com.au> Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Lisette Scheer <lisette@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Lisette Scheer <lisette@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |release-notes-needed -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Lucas Gass (lukeg) <lucas@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |lucas@bywatersolutions.com Keywords| |rel_26_05_candidate -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Lucas Gass (lukeg) <lucas@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)| |26.05.00 released in| | Status|Passed QA |Pushed to main -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 --- Comment #15 from Lucas Gass (lukeg) <lucas@bywatersolutions.com> --- Nice work everyone! Pushed to main for 26.05 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Lucas Gass (lukeg) <lucas@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords|rel_26_05_candidate, | |release-notes-needed | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Text to go in the| |Use release notes| |`misc/bin/connexion_import_ | |daemon.pl --help` to view | |more detailed information | |about the options available | |for this script. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to main |Needs documenting --- Comment #16 from Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> --- This bug won't be backported to the 25.11.x branch as it has been deemed an enhancement or new feature. -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org