From: Jean-Noël AVILA <jn.avila@free.fr>
Date: Tue, 05 Aug 2025 17:04:23 GMT
Subject: Re: [PATCH v5 1/9] Documentation/git-reflog: convert to use synopsis type
Message-ID: <5910515.DvuYhMxLoT@cayenne>
In-Reply-To: <20250805-pks-reflog-append-v5-1-050997db09d5@pks.im>

On Tuesday, 5 August 2025 17:11:31 CEST Patrick Steinhardt wrote:
> With 974cdca345c (doc: introduce a synopsis typesetting, 2024-09-24) we
> have introduced a new synopsis type that simplifies the rules for
> typesetting a command's synopsis. Convert the git-reflog(1)
> documentation to use it.
> 
> Signed-off-by: Patrick Steinhardt <ps@pks.im>
> ---
>  Documentation/git-reflog.adoc | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/Documentation/git-reflog.adoc b/Documentation/git-reflog.adoc
> index 412f06b8fe..707a9b39ed 100644
> --- a/Documentation/git-reflog.adoc
> +++ b/Documentation/git-reflog.adoc
> @@ -8,16 +8,16 @@ git-reflog - Manage reflog information
> 
>  SYNOPSIS
>  --------
> -[verse]
> -'git reflog' [show] [<log-options>] [<ref>]
> -'git reflog list'
> -'git reflog expire' [--expire=<time>] [--expire-unreachable=<time>]
> +[synopsis]
> +git reflog [show] [<log-options>] [<ref>]
> +git reflog list
> +git reflog expire [--expire=<time>] [--expire-unreachable=<time>]
>  	[--rewrite] [--updateref] [--stale-fix]
>  	[--dry-run | -n] [--verbose] [--all [--single-worktree] | <refs>...]
> -'git reflog delete' [--rewrite] [--updateref]
> +git reflog delete [--rewrite] [--updateref]
>  	[--dry-run | -n] [--verbose] <ref>@{<specifier>}...
> -'git reflog drop' [--all [--single-worktree] | <refs>...]
> -'git reflog exists' <ref>
> +git reflog drop [--all [--single-worktree] | <refs>...]
> +git reflog exists <ref>
> 
>  DESCRIPTION
>  -----------


Hello,

Be careful that with the doc lint series I'm proposing, this change will raise 
a failure: one of the tests checks that switching the main synopsis to 
[synopsis] is linked to switching the definitions lists to inline synopsis, 
using `backticks`. This check may be too restrictive though.

Jean-Noël