Re: [PATCH 1/1] show-ref: improve short help messages of options
- From
Patrick Steinhardt <ps@pks.im>
- Date
- Jul 25, 2024, 07:15 UTC
- Message-ID
- <ZqH7mDh73vkX4bPT@tanuki>
- In-Reply-To
- <20240724111116.91615-1-ash@kambanaria.org>
On Wed, Jul 24, 2024 at 02:11:11PM +0300, Alexander Shopov wrote:
Show 15 quoted lines
> diff --git a/builtin/show-ref.c b/builtin/show-ref.c
> index 839a5c29f3..85700caae9 100644
> --- a/builtin/show-ref.c
> +++ b/builtin/show-ref.c
> @@ -293,8 +293,8 @@ int cmd_show_ref(int argc, const char **argv, const char *prefix)
> struct show_one_options show_one_opts = {0};
> int verify = 0, exists = 0;
> const struct option show_ref_options[] = {
> - OPT_BOOL(0, "tags", &patterns_opts.tags_only, N_("only show tags (can be combined with branches)")),
> - OPT_BOOL(0, "branches", &patterns_opts.branches_only, N_("only show branches (can be combined with tags)")),
> + OPT_BOOL(0, "tags", &patterns_opts.tags_only, N_("only show tags (can be combined with --branches)")),
> + OPT_BOOL(0, "branches", &patterns_opts.branches_only, N_("only show branches (can be combined with --tags)")),
> OPT_HIDDEN_BOOL(0, "heads", &patterns_opts.branches_only,
> N_("deprecated synonym for --branches")),
> OPT_BOOL(0, "exists", &exists, N_("check for reference existence without resolving")),Agreed, I think that this is a sensible change. In practice, this feature can also be combined with `--head`, so in that spirit we might even change it to:
"only show tags (can be combined with --branches and --head)"
Not sure though whether this is getting too noisy?
Patrick