From df8ff99830e2533141839f6dbaec1149093d22c5 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Sep 23 2013 21:07:33 +0000 Subject: Update tcar_printHelp implementation. - Previously, you could pass an argument to --help option to read documentation about specific files. The initial idea doesn't look bad but I need to be pragmatic about the fact won't go to document everything file at this moment. I will create module documentation only and everything else will be put in comments, inside script files. This update changes the script and documentation files to remove the argument references passed to --help option. Just --help, without argument, will be supported by now. --- diff --git a/Automation/Modules/Locale/Manuals/centos-art.sh-locale.asciidoc b/Automation/Modules/Locale/Manuals/centos-art.sh-locale.asciidoc index 1d32294..7d5751d 100644 --- a/Automation/Modules/Locale/Manuals/centos-art.sh-locale.asciidoc +++ b/Automation/Modules/Locale/Manuals/centos-art.sh-locale.asciidoc @@ -63,7 +63,10 @@ Options The *locale* module accepts the following options: -*-h, --help*:: +*--help*:: + Print module's documentation. +*--version*:: + Print module's version. *--filter="REGEX"*:: When ``DIRECTORY'' is passed as argument, this option reduces the number of section blocks inside configuration files the *locale* diff --git a/Automation/Modules/Locale/locale_getOptions.sh b/Automation/Modules/Locale/locale_getOptions.sh index 08f970e..7f126b9 100755 --- a/Automation/Modules/Locale/locale_getOptions.sh +++ b/Automation/Modules/Locale/locale_getOptions.sh @@ -28,10 +28,10 @@ function locale_getOptions { # Define short options we want to support. - local ARGSS="h::,v" + local ARGSS="h,v" # Define long options we want to support. - local ARGSL="help::,version,filter:,update,edit,delete" + local ARGSL="help,version,filter:,update,edit,delete" # Redefine arguments using getopt(1) command parser. tcar_setArguments "${@}" @@ -45,8 +45,7 @@ function locale_getOptions { case "${1}" in -h | --help ) - tcar_printHelp "${2}" - shift 2 + tcar_printHelp ;; -v | --version ) diff --git a/Automation/Modules/Prepare/Manuals/centos-art.sh-prepare.asciidoc b/Automation/Modules/Prepare/Manuals/centos-art.sh-prepare.asciidoc index 7e8b290..d12ec82 100644 --- a/Automation/Modules/Prepare/Manuals/centos-art.sh-prepare.asciidoc +++ b/Automation/Modules/Prepare/Manuals/centos-art.sh-prepare.asciidoc @@ -49,18 +49,10 @@ Options The *prepare* module accepts the following options: *--help*:: -*--help="FILE.sh"*:: - When no argument is provided to this option, it shows the module's - documentation for regular users. When a filename and its extension - is provided to this option, documentation for developers is - printed instead. Developers' documentation adds information about - the module's execution environment while user's documentation - doesn't. In order to print developer documentation, the file name - you provide must be part of the module you request help to and - having a related manpage inside the module's Manuals directory. + Print module's documentation. *--version*:: - This option shows the module's name and version. + Print module's version. *--packages*:: This option verifies whether you have installed the required diff --git a/Automation/Modules/Prepare/prepare_getOptions.sh b/Automation/Modules/Prepare/prepare_getOptions.sh index 558ebd1..6a0eece 100755 --- a/Automation/Modules/Prepare/prepare_getOptions.sh +++ b/Automation/Modules/Prepare/prepare_getOptions.sh @@ -30,10 +30,10 @@ function prepare_getOptions { # Define short options we want to support. - local ARGSS="h::,v" + local ARGSS="h,v" # Define long options we want to support. - local ARGSL="help::,version,packages,locales,links,documents,images" + local ARGSL="help,version,packages,locales,links,documents,images" # Redefine arguments using getopt(1) command parser. tcar_setArguments "${@}" diff --git a/Automation/Modules/Render/Manuals/centos-art.sh-render.asciidoc b/Automation/Modules/Render/Manuals/centos-art.sh-render.asciidoc index cf9e406..e5a91dc 100644 --- a/Automation/Modules/Render/Manuals/centos-art.sh-render.asciidoc +++ b/Automation/Modules/Render/Manuals/centos-art.sh-render.asciidoc @@ -29,9 +29,9 @@ Options The *render* module accepts the following options: *--help*:: - This option shows the *render* module's documentation (this page). + Print module's documentation. *--version*:: - This option shows the *render* module's name and version. + Print module's version. *--filter="REGEX"*:: This option reduces the number of section blocks inside configuration files the *render* module will take for processing. diff --git a/Automation/Modules/Tuneup/Manuals/tuneup.asciidoc b/Automation/Modules/Tuneup/Manuals/tuneup.asciidoc index 9bbae55..bfe5edd 100644 --- a/Automation/Modules/Tuneup/Manuals/tuneup.asciidoc +++ b/Automation/Modules/Tuneup/Manuals/tuneup.asciidoc @@ -10,13 +10,6 @@ repository. Synopsis -------- -*centos-art.sh tuneup --help*:: - Print module's documentation for users. - -*centos-art.sh tuneup --help="FILE.sh"*:: - Print module's documentation for developers. Here, FILE.sh is the - name of the file you want to read documentation from. - *centos-art.sh tuneup [FILE ...|DIRECTORY ...] [--filter="REGEX"]*:: Execute source code maintenance tasks. @@ -134,6 +127,10 @@ license information. Everything else does remain untouched. Options ------- +*--help*:: + Print module's documentation. +*--version*:: + Print module's version. *--filter="REGEX"*:: This option let you reduce the number of files you want to process by applying a (POSIX-egrep) regular expression to the list of file diff --git a/Automation/Modules/Tuneup/tuneup_getOptions.sh b/Automation/Modules/Tuneup/tuneup_getOptions.sh index c41d2c3..196ba52 100755 --- a/Automation/Modules/Tuneup/tuneup_getOptions.sh +++ b/Automation/Modules/Tuneup/tuneup_getOptions.sh @@ -28,10 +28,10 @@ function tuneup_getOptions { # Define short options we want to support. - local ARGSS="h::,v" + local ARGSS="h,v" # Define long options we want to support. - local ARGSL="help::,version,filter:" + local ARGSL="help,version,filter:" # Redefine arguments using getopt(1) command parser. tcar_setArguments "${@}" @@ -45,8 +45,7 @@ function tuneup_getOptions { case "${1}" in -h | --help ) - tcar_printHelp "${2}" - shift 2 + tcar_printHelp ;; -v | --version ) diff --git a/Automation/Scripts/tcar_printHelp.sh b/Automation/Scripts/tcar_printHelp.sh index 7f279b2..9d3ad28 100755 --- a/Automation/Scripts/tcar_printHelp.sh +++ b/Automation/Scripts/tcar_printHelp.sh @@ -29,10 +29,6 @@ function tcar_printHelp { local MANPAGE="${TCAR_SCRIPT_NAME}-${MODULE_NAME}" - if [[ -n ${1} ]];then - MANPAGE=${1} - fi - /usr/bin/man -M ${MODULE_DIR_MANUALS} "${MANPAGE}" exit 0