diff options
author | Juan Castillo <juan.castillo@arm.com> | 2015-12-15 16:37:57 +0000 |
---|---|---|
committer | Juan Castillo <juan.castillo@arm.com> | 2016-01-07 14:48:27 +0000 |
commit | 159807e2faa50a2940f09d57dfa6132220508cce (patch) | |
tree | 4df4188a2552c735d205d79d09ed258ae568b5d8 /tools/cert_create/include | |
parent | d0c104e1e1ad0102f0f4c70997b7ee6e6fbbe273 (diff) | |
download | trusted-firmware-a-159807e2faa50a2940f09d57dfa6132220508cce.tar.gz |
cert_create: update help message
The help message printed by the cert_create tool using the command
line option -h (or --help) does not correctly list all the available
command line options.
This patch reworks the print_help() function to print the help
messages in a data driven approach. For each command line option
registered, an optional help message can be specified, which will
be printed by print_help().
Help messages for the TBBR options (certificates, keys and images)
are also provided.
Fix a small bug in the short options string passed to getopt_long:
the ':' was missing in the '-a' option (this option must take an
argument).
Fixes ARM-software/tf-issues#337
Change-Id: I9d08c2dfd349022808fcc884724f677eefdc1452
Diffstat (limited to 'tools/cert_create/include')
-rw-r--r-- | tools/cert_create/include/cert.h | 1 | ||||
-rw-r--r-- | tools/cert_create/include/cmd_opt.h | 9 | ||||
-rw-r--r-- | tools/cert_create/include/ext.h | 1 | ||||
-rw-r--r-- | tools/cert_create/include/key.h | 1 |
4 files changed, 11 insertions, 1 deletions
diff --git a/tools/cert_create/include/cert.h b/tools/cert_create/include/cert.h index 11381c93c8..d38353a10b 100644 --- a/tools/cert_create/include/cert.h +++ b/tools/cert_create/include/cert.h @@ -57,6 +57,7 @@ struct cert_s { const char *opt; /* Command line option to pass filename */ const char *fn; /* Filename to save the certificate */ const char *cn; /* Subject CN (Company Name) */ + const char *help_msg; /* Help message */ /* These fields must be defined statically */ int key; /* Key to be signed */ diff --git a/tools/cert_create/include/cmd_opt.h b/tools/cert_create/include/cmd_opt.h index ca48d7caf3..389aa23363 100644 --- a/tools/cert_create/include/cmd_opt.h +++ b/tools/cert_create/include/cmd_opt.h @@ -42,9 +42,16 @@ enum { CMD_OPT_EXT }; +/* Structure to define a command line option */ +typedef struct cmd_opt_s { + struct option long_opt; + const char *help_msg; +} cmd_opt_t; + /* Exported API*/ -int cmd_opt_add(const char *name, int has_arg, int val); +void cmd_opt_add(const cmd_opt_t *cmd_opt); const struct option *cmd_opt_get_array(void); const char *cmd_opt_get_name(int idx); +const char *cmd_opt_get_help_msg(int idx); #endif /* CMD_OPT_H_ */ diff --git a/tools/cert_create/include/ext.h b/tools/cert_create/include/ext.h index 0ede365181..52092b508d 100644 --- a/tools/cert_create/include/ext.h +++ b/tools/cert_create/include/ext.h @@ -50,6 +50,7 @@ typedef struct ext_s { const char *oid; /* OID of the extension */ const char *sn; /* Short name */ const char *ln; /* Long description */ + const char *help_msg; /* Help message */ int asn1_type; /* OpenSSL ASN1 type of the extension data. * Supported types are: * - V_ASN1_INTEGER diff --git a/tools/cert_create/include/key.h b/tools/cert_create/include/key.h index 6995a06339..2171679c8c 100644 --- a/tools/cert_create/include/key.h +++ b/tools/cert_create/include/key.h @@ -64,6 +64,7 @@ enum { typedef struct key_s { int id; /* Key id */ const char *opt; /* Command line option to specify a key */ + const char *help_msg; /* Help message */ const char *desc; /* Key description (debug purposes) */ char *fn; /* Filename to load/store the key */ EVP_PKEY *key; /* Key container */ |