Docs: eg_db_config typo --update-config

Bug #1463097 reported by Josh Stompro
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Evergreen
Fix Released
Low
Unassigned
2.7
Fix Released
Low
Unassigned
2.8
Fix Released
Low
Unassigned

Bug Description

Evergreen 2.8.0

Hello, I think there is a small typo in the help for Open-ILS/src/support-scripts/eg_db_config.

I was just reading through it and saw that the description for --update-config says that it updates the file specified by --build-db-file, but I believe it should be --config-file. I don't think --update-config makes changes to "Open-ILS/src/sql/pg/build-db.sh"

OPTIONS
    --config-file
        specifies the opensrf.xml file. Defaults to /openils/conf/opensrf.xml

    --build-db-file
        specifies the script that creates the database schema. Defaults to
        Open-ILS/src/sql/pg/build-db.sh

    --offline-file
        specifies the offline database settings file required by the offline
        data uploader. Defaults to /openils/conf/offline-config.pl

COMMANDS
    --update-config
        Configures Evergreen database settings in the file specified by
        --build-db-file.

Revision history for this message
Josh Stompro (u-launchpad-stompro-org) wrote :

Also --create-schema may be wrong - maybe those two were transposed.

    --create-schema
        Creates the Evergreen database schema according to the settings in
        the file specified by --config-file.

But that should probably be --build-db-file instead of --config-file.

Revision history for this message
Josh Stompro (u-launchpad-stompro-org) wrote :

user/stompro/lp1463097_eg_db_config_help_typo
http://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/stompro/lp1463097_eg_db_config_help_typo

Here is a working branch to fix this typo.
Josh

tags: added: pullrequest
removed: bitesize-doc
Revision history for this message
Galen Charlton (gmc) wrote :

Pushed to master, rel_2_8, and rel_2_7. Thanks, Josh!

Changed in evergreen:
status: New → Fix Committed
importance: Undecided → Low
milestone: none → 2.9-beta
Changed in evergreen:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.