Documentation needed for srfsh scripts in /openils/bin

[Victoria]

The srfsh scripts in /openils/bin are used for various maintenance tasks and are most often run using cron jobs, but I am unable to find any documentation related to their use, command line options, etc. I ran into an issue where I probably should have known that I needed to set up a .srfsh.xml file in ~/opensrf so that the scripts would run on the private.localhost router when cron started them, but I didn't have any clue it was needed. I had only played with the .srfsh.xml file during opensrf testing; after that, it was never mentioned again to my knowledge.

So: more documentation on when, how, and why to run the various scripts would be great. This type of documentation could go into the "post-installation chores" area.

[Michael Peters (mrpeters)]

Wondering if this is perhaps a bug more appropriate for DIG?

[Victoria (vbush)]

Absolutely, but I don't recall seeing a bug queue for the documentation. Please correct me and point me to the right place, if such exists.

[Remington Steed (rjs7)]

I have revived and updated a long-lost section of documentation from the old 2.1 docs. Here is the commit:

http://git.evergreen-ils.org/?p=Evergreen.git;a=commit;h=cbf755bd65317f6a0f84fa13a5404eb02d0c9a6d

And since docs changes don't currently require two sign-offs, I have pushed it into master. I'll mark this bug as "Fix Committed" for now, and change it to "Fix Released" after I review the version that builds overnight (and backport to 2.6).

I expect the new sections to appear here after backporting:

http://docs.evergreen-ils.org/2.6/_batch_importing_marc_records.html
(look for "Importing Authority Records from the Staff Client", should be the last subsection)

http://docs.evergreen-ils.org/2.6/_developer_resources.html
(look for "Support Scripts", should be first chapter after intro)

[Remington Steed (rjs7)]

Everything looks good in the master version built last night, so I have backported the change through 2.4 (since 2.4 is still supported in some capacity). When I confirm that those versions of the docs have updated properly, I will change this bug's status to "Fix Released".