]> git.ipfire.org Git - thirdparty/krb5.git/commit
Synchronize command-line option documentation
authorRobbie Harwood <rharwood@redhat.com>
Fri, 15 Jan 2021 20:55:01 +0000 (15:55 -0500)
committerGreg Hudson <ghudson@mit.edu>
Wed, 17 Feb 2021 22:56:58 +0000 (17:56 -0500)
commitc7849209027575841e95350ef0e48c54665cfe0f
tree2fc62a5ae47471eae081bab156e061a3c099b140
parent2a3a4088ecafea68d0a91a48c4abc3c11cdf59d8
Synchronize command-line option documentation

Command-line options are described in the following places:

- .rst file "SYNOPSIS" section
- .rst file "OPTIONS" section
- parameters to getopt()
- results of getopt() that are actually handled
- a usage() or xusage() function
- occasionally, a long form in usage()/xusage()
- occasionally, libss subcommand specifications

Over time, these have drifted.  Make an effort to correct this drift,
marking deprecated options as such.  For consistency, remove mention
of long arguments that have an equivalent short form.

(cherry picked from commit bd912c8583261f1f2521a06e5c05757cec032580)

ticket: 8987
version_fixed: 1.19.1
15 files changed:
doc/admin/admin_commands/kadmin_local.rst
doc/admin/admin_commands/kpropd.rst
doc/admin/admin_commands/ktutil.rst
doc/user/user_commands/kdestroy.rst
doc/user/user_commands/kinit.rst
doc/user/user_commands/klist.rst
src/build-tools/krb5-config.in
src/clients/kinit/kinit.c
src/clients/klist/klist.c
src/kadmin/cli/kadmin.c
src/kadmin/dbutil/dump.c
src/kadmin/dbutil/kdb5_util.c
src/kadmin/dbutil/tabdump.c
src/kdc/main.c
src/kprop/kpropd.c