Re: [PATCH v2] git-status.txt: fix minor asciidoc format issue

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 3, 2023, 20:25 UTC
Message-ID: <xmqq4jj7zc5b.fsf@gitster.g>
In-Reply-To: <pull.1591.v2.git.1696350802820.gitgitgadget@gmail.com>

"cousteau via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 7 quoted lines

> From: Javier Mora <cousteaulecommandant@gmail.com>
>
> The paragraph below the list of short option combinations
> isn't correctly formatted, making the result hard to read.
>
> Signed-off-by: Javier Mora <cousteaulecommandant@gmail.com>
> ---

The above probably no longer describes the situation the patch intends to correct, I suspect. It used to be near-impossible hard to read, but at least with them indented they are legible.

	The additional states for submodules are typeset differently
	from how the states for paths for normal blobs are listed as
	enumeration.  Format them in the same way for consistency.

or something like that, perhaps.

Show 21 quoted lines

>  Documentation/git-status.txt | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
> index b27d127b5e2..48f46eb2047 100644
> --- a/Documentation/git-status.txt
> +++ b/Documentation/git-status.txt
> @@ -246,10 +246,9 @@ U           U    unmerged, both modified
>  
>  Submodules have more state and instead report
>  
> -		M    the submodule has a different HEAD than
> -		     recorded in the index
> -		m    the submodule has modified content
> -		?    the submodule has untracked files
> +* 'M' = the submodule has a different HEAD than recorded in the index
> +* 'm' = the submodule has modified content
> +* '?' = the submodule has untracked files
>  
>  since modified content or untracked files in a submodule cannot be added
>  via `git add` in the superproject to prepare a commit.

Thanks for making this part of the documentation better.