gsctool: further optimize parameter description

There is no need to duplicate short and long option strings in the
.opt and .help_text fields, one is enough.

To properly format --help output in case the command line argument
expects a parameter, part of the .help_text string has to be printed
concatenated with the option strings.

Let's retrieve the short and long option strings form from the .opt
structure and use '%' as the formatting character to allow to indicate
that the the beginning of the help message needs to be printed
concatenated with the option strings.

Also correct the general description.

BRANCH=none
BUG=none
TEST=help text before this change:

vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
$ gsctool -h

Usage: gsctool [options] [<binary image>]

This utility allows to update Cr50 RW firmware, configure
various aspects of Cr50 operation, analyze Cr50 binary
images, etc.
The required argument is the file name of a full RO+RW
binary image.
A typical Chromebook use would expect -s -t options
included in the command line.

Options:

  -a,--any                 Try any interfaces to find Cr50 (-d, -s, -t are all ignored)
  -b,--binvers             Report versions of Cr50 image's RW and RO headers, do not update
  -c,--corrupt             Corrupt the inactive rw
  -d,--device  VID:PID     USB device (default 18d1:5014)
  -f,--fwver               Report running Cr50 firmware versions
  -F,--factory [enable|disable]
                           Control factory mode
  -h,--help                Show this message
  -I,--ccd_info            Get information about CCD state
  -i,--board_id [ID[:FLAGS]]
                           Get or set Info1 board ID fields
                           ID could be 32 bit hex or 4 character string.
  -k,--ccd_lock            Lock CCD
  -L,--flog [prev entry]   Retrieve contents of the flash log (newer than <prev entry> if specified)
  -M,--machine             Output in a machine-friendly way. Effective with -b, -f, -i, and -O.
  -m,--tpm_mode [enable|disable]
                           Change or query tpm_mode
  -n,--serial SERIAL       Cr50 CCD serial number
  -O,--openbox_rma <desc_file>
                           Verify other device's RO integrity
                           using information provided in <desc file>
  -o,--ccd_open            Start CCD open sequence
  -P,--password
                           Set or clear CCD password. Use
                           'clear:<cur password>' to clear it
  -p,--post_reset          Request post reset after transfer
  -R,--sn_rma_inc RMA_INC
                           Increment SN RMA count by RMA_INC.
                           RMA_INC should be 0-7.
  -r,--rma_auth [auth_code]
                           Request RMA challenge, process RMA authentication code
  -S,--sn_bits SN_BITS
                           Set Info1 SN bits fields.
                           SN_BITS should be 96 bit hex.
  -s,--systemdev           Use /dev/tpm0 (-d is ignored)
  -T,--tstamp <stamp>      Set flash log timestamp base
  -t,--trunks_send         Use `trunks_send --raw' (-d is ignored)
  -U,--ccd_unlock          Start CCD unlock sequence
  -u,--upstart             Upstart mode (strict header checks)
  -V,--verbose             Enable debug messages
  -v,--version             Report this utility version
  -w,--wp                  Get the current wp setting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

and after this change:

vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
$ ./extra/usb_updater/gsctool -h

Usage: gsctool [options] [<binary image>]

This utility allows to update Cr50 RW firmware, configure
various aspects of Cr50 operation, analyze Cr50 binary
images, etc.

<binary image> is the file name of a full RO+RW binary image.

Options:

 -a,--any                  Try any interfaces to find Cr50 (-d, -s, -t are all ignored)
 -B,--background_update_supported
                           Force background update mode (relevant only when interacting with Cr50 versions before 0.0.19)
 -b,--binvers              Report versions of Cr50 image's RW and RO headers, do not update
 -c,--corrupt              Corrupt the inactive rw
 -d,--device  VID:PID      USB device (default 18d1:5014)
 -f,--fwver                Report running Cr50 firmware versions
 -F,--factory [enable|disable]
                           Control factory mode
 -h,--help                 Show this message
 -I,--ccd_info             Get information about CCD state
 -i,--board_id [ID[:FLAGS]]
                           Get or set Info1 board ID fields. ID could be 32 bit hex or 4 character string.
 -k,--ccd_lock             Lock CCD
 -L,--flog [prev entry]    Retrieve contents of the flash log (newer than <prev entry> if specified)
 -M,--machine              Output in a machine-friendly way. Effective with -b, -f, -i, and -O.
 -m,--tpm_mode [enable|disable]
                           Change or query tpm_mode
 -n,--serial               Cr50 CCD serial number
 -O,--openbox_rma <desc_file>
                           Verify other device's RO integrity using information provided in <desc file>
 -o,--ccd_open             Start CCD open sequence
 -P,--password             Set or clear CCD password. Use 'clear:<cur password>' to clear it
 -p,--post_reset           Request post reset after transfer
 -R,--sn_rma_inc RMA_INC   Increment SN RMA count by RMA_INC. RMA_INC should be 0-7.
 -r,--rma_auth [auth_code]
                           Request RMA challenge, process RMA authentication code
 -S,--sn_bits SN_BITS      Set Info1 SN bits fields. SN_BITS should be 96 bit hex.
 -s,--systemdev            Use /dev/tpm0 (-d is ignored)
 -T,--tstamp [<tstamp>]    Get or set flash log timestamp base
 -t,--trunks_send          Use `trunks_send --raw' (-d is ignored)
 -U,--ccd_unlock           Start CCD unlock sequence
 -u,--upstart              Upstart mode (strict header checks)
 -V,--verbose              Enable debug messages
 -v,--version              Report this utility version
 -w,--wp                   Get the current wp setting

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Change-Id: I5afd2473dbdaf9edc515ee9f02b932effe3755c5
Signed-off-by: Vadim Bendebury <vbendeb@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/1628113
Legacy-Commit-Queue: Commit Bot <commit-bot@chromium.org>
Reviewed-by: Andrey Pronin <apronin@chromium.org>

0 files changed, 0 insertions, 0 deletions