From: "René Scharfe" <rene.scharfe@lsrfire.ath.cx>
To: Git Mailing List <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 0/7] add description parameter to standard option macros
Date: Mon, 08 Nov 2010 18:53:27 +0100 [thread overview]
Message-ID: <4CD83917.3040801@lsrfire.ath.cx> (raw)
This patch series is meant to improve the command line help texts
for standard options.
The first three patches add a description parameter to three helper
macros. This allows command specific help texts to be defined for them
instead of enforcing ones that just repeat the option name.
[PATCH 1/7] add description parameter to OPT__VERBOSE
[PATCH 2/7] add description parameter to OPT__DRY_RUN
[PATCH 3/7] add description parameter to OPT__QUIET
The next patch adds a similar helper macro for -f/--force. It makes
it easier to define such an option in a consistent way.
[PATCH 4/7] add OPT__FORCE
The last three patches depend on the first one and replace the standard
help text with a (hopefully) better explanation.
[PATCH 5/7] archive: improve --verbose description
[PATCH 6/7] branch: improve --verbose description
[PATCH 7/7] verify-tag: document --verbose
Further patches to improve the remaining occurrences of "be verbose"
etc. are encouraged. :-)
Documentation/git-verify-tag.txt | 4 ++++
Documentation/technical/api-parse-options.txt | 9 ++++++---
archive.c | 2 +-
builtin/add.c | 6 +++---
builtin/apply.c | 2 +-
builtin/branch.c | 5 +++--
builtin/checkout-index.c | 5 ++---
builtin/checkout.c | 4 ++--
builtin/clean.c | 6 +++---
builtin/commit.c | 6 +++---
builtin/count-objects.c | 2 +-
builtin/fetch.c | 3 +--
builtin/fsck.c | 2 +-
builtin/gc.c | 2 +-
builtin/grep.c | 4 ++--
builtin/log.c | 2 +-
builtin/merge-file.c | 2 +-
builtin/mv.c | 4 ++--
builtin/notes.c | 9 ++++-----
builtin/prune.c | 5 ++---
builtin/read-tree.c | 2 +-
builtin/remote.c | 4 ++--
builtin/reset.c | 2 +-
builtin/rm.c | 6 +++---
builtin/show-ref.c | 2 +-
builtin/symbolic-ref.c | 2 +-
builtin/tag.c | 2 +-
builtin/update-server-info.c | 3 +--
builtin/verify-tag.c | 2 +-
parse-options.h | 7 ++++---
test-parse-options.c | 6 +++---
test-sha1.sh | 14 ++++++++------
32 files changed, 71 insertions(+), 65 deletions(-)
next reply other threads:[~2010-11-08 17:53 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-11-08 17:53 René Scharfe [this message]
2010-11-08 17:58 ` [PATCH 2/7] add description parameter to OPT__DRY_RUN René Scharfe
2010-11-08 18:00 ` [PATCH 3/7] add description parameter to OPT__QUIET René Scharfe
2010-11-08 18:06 ` René Scharfe
2010-11-08 18:18 ` Jeff King
2010-11-08 19:54 ` Jonathan Nieder
2010-11-08 19:57 ` Jeff King
2010-11-08 21:06 ` René Scharfe
2010-11-08 18:01 ` [PATCH 4/7] add OPT__FORCE René Scharfe
2010-11-08 18:02 ` [PATCH 5/7] archive: improve --verbose description René Scharfe
2010-11-08 18:03 ` [PATCH 6/7] branch: " René Scharfe
2010-11-08 18:04 ` [PATCH 7/7] verify-tag: document --verbose René Scharfe
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4CD83917.3040801@lsrfire.ath.cx \
--to=rene.scharfe@lsrfire.ath.cx \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).