git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 5/8] git reflog [expire|delete]: make -h output consistent with SYNOPSIS

From
Junio C Hamano <gitster@pobox.com>
Date
Mar 18, 2022, 01:24 UTC
Message-ID
<xmqqczikcasz.fsf@gitster.g>
In-Reply-To
<patch-5.8-130e718722b-20220317T180439Z-avarab@gmail.com>
Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:
> Make use of the guaranteed pretty alignment of "-h" output added in my
> 4631cfc20bd (parse-options: properly align continued usage output,
> 2021-09-21) and wrap and format the "git reflog [expire|delete] -h"

"(expire|delete) -h", I think. Does it matter who wrote an earlier commit, by the way? You do not name who did 33d7bdd6459 you refer to in the later part of the proposed log message, for example, and it feels simpler to consider all the past commits as just "ours".

Show 29 quoted lines
> usage output. Also add the missing "--single-worktree" option, as well
> as adding other things that were in the SYNOPSIS output, but not in
> the "-h" output.
>
> This was last touched in 33d7bdd6459 (builtin/reflog.c: use
> parse-options api for expire, delete subcommands, 2022-01-06), but in
> that commit the previous usage() output was faithfully
> reproduced. Let's follow-up on that and make this even easier to read.
>
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> ---
>  builtin/reflog.c | 11 +++++------
>  1 file changed, 5 insertions(+), 6 deletions(-)
>
> diff --git a/builtin/reflog.c b/builtin/reflog.c
> index 25313d504a9..458764400b5 100644
> --- a/builtin/reflog.c
> +++ b/builtin/reflog.c
> @@ -6,14 +6,13 @@
>  #include "reflog.h"
>  
>  #define BUILTIN_REFLOG_EXPIRE_USAGE \
> -	N_("git reflog expire [--expire=<time>] " \
> -	   "[--expire-unreachable=<time>] " \
> -	   "[--rewrite] [--updateref] [--stale-fix] [--dry-run | -n] " \
> -	   "[--verbose] [--all] <refs>...")
> +	N_("git reflog expire [--expire=<time>] [--expire-unreachable=<time>]\n" \
> +	   "                  [--rewrite] [--updateref] [--stale-fix]\n" \
> +	   "                  [--dry-run | -n] [--verbose] [--all [--single-worktree] | <refs>...]")

OK. This makes the line folding match what we write in the synopsis section of the documentation.

Show 5 quoted lines
>  #define BUILTIN_REFLOG_DELETE_USAGE \
> -	N_("git reflog delete [--rewrite] [--updateref] " \
> -	   "[--dry-run | -n] [--verbose] <refs>...")
> +	N_("git reflog delete [--rewrite] [--updateref]\n" \
> +	   "                  [--dry-run | -n] [--verbose] <ref>@{<specifier>}...")
Likewise.  Looking good.
>  #define BUILTIN_REFLOG_EXISTS_USAGE \
>  	N_("git reflog exists <ref>")
Previous: Ævar Arnfjörð BjarmasonNext: Ævar Arnfjörð Bjarmason
Message 8 of 15 in “reflog: migrate fully to parse_options()”
  1. 0/8 reflog: migrate fully to parse_options()Ævar Arnfjörð Bjarmason, Mar 17, 2022
  2. 1/8 reflog.c: indent argument listsÆvar Arnfjörð Bjarmason, Mar 17, 2022
  3. John CaiMar 17, 2022
  4. 2/8 reflog: refactor cmd_reflog() to "if" branchesÆvar Arnfjörð Bjarmason, Mar 17, 2022
  5. 3/8 reflog tests: add missing "git reflog exists" testsÆvar Arnfjörð Bjarmason, Mar 17, 2022
  6. 4/8 reflog: move "usage" variables and use macrosÆvar Arnfjörð Bjarmason, Mar 17, 2022
  7. 5/8 git reflog [expire|delete]: make -h output consistent with SYNOPSISÆvar Arnfjörð Bjarmason, Mar 17, 2022
  8. Junio C HamanoMar 18, 2022
  9. 6/8 reflog exists: use parse_options() APIÆvar Arnfjörð Bjarmason, Mar 17, 2022
  10. Junio C HamanoMar 18, 2022
  11. 7/8 reflog: convert to parse_options() APIÆvar Arnfjörð Bjarmason, Mar 17, 2022
  12. Junio C HamanoMar 18, 2022
  13. 8/8 reflog [show]: display sensible -h outputÆvar Arnfjörð Bjarmason, Mar 17, 2022
  14. reflog: fix 'show' subcommand's argvSZEDER Gábor, Mar 28, 2022
  15. Junio C HamanoMar 28, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.