Re: [PATCH] doc/ls-files: put nested list for "-t" option into block

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 23, 2019, 01:24 UTC
Message-ID: <xmqqzhoh5x98.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20190422151541.GA1633@sigill.intra.peff.net>

Jeff King <peff@peff.net> writes:

Show 5 quoted lines

> We could fix it by adding a "+" before the sub-list to connect it to the
> rest of the "-t" text. But using a pair of "--" to delimit the block is
> perhaps more readable, and may have better compatibility with
> asciidoctor, as in 39a869b2f2 (Documentation/rev-list-options: wrap
> --date=<format> block with "--", 2019-03-30).

OK, thanks.

> Junio: I happened to notice this while hunting for "ls-files" options
>        that could make your makefile de-dup patch unnecessary (but
>        didn't find anything).

Yup, I was looking at builtin/ls-files.c before sending the Makefile patch, too ;-)

Show 23 quoted lines

>  Documentation/git-ls-files.txt | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
> index 5298f1bc30..8461c0e83e 100644
> --- a/Documentation/git-ls-files.txt
> +++ b/Documentation/git-ls-files.txt
> @@ -118,6 +118,7 @@ OPTIONS
>  	linkgit:git-status[1] `--short` or linkgit:git-diff[1]
>  	`--name-status` for more user-friendly alternatives.
>  +
> +--
>  This option identifies the file status with the following tags (followed by
>  a space) at the start of each line:
>  
> @@ -128,6 +129,7 @@ a space) at the start of each line:
>  	C::	modified/changed
>  	K::	to be killed
>  	?::	other
> +--
>  
>  -v::
>  	Similar to `-t`, but use lowercase letters for files