[PATCH] Documentation: improve git ls-files -s manpage entry

[PATCH] Documentation: improve git ls-files -s manpage entry

[Mostyn Bramley-Moore]

List the fields in order of appearance in the command output.

Signed-off-by: Mostyn Bramley-Moore <mostyn@antipode.se>
---
 Documentation/git-ls-files.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 1cab703..a9149fc 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -57,7 +57,8 @@ OPTIONS
 
 -s::
 --stage::
-	Show staged contents' object name, mode bits and stage number in the output.
+	Show staged contents' mode bits, hash, stage number as well as the
+	object name in the output.
 
 --directory::
 	If a whole directory is classified as "other", show just its
-- 
2.9.3

Re: [PATCH] Documentation: improve git ls-files -s manpage entry

[Junio C Hamano]

Mostyn Bramley-Moore <mostyn@antipode.se> writes:

> List the fields in order of appearance in the command output.
>
> Signed-off-by: Mostyn Bramley-Moore <mostyn@antipode.se>
> ---
>  Documentation/git-ls-files.txt | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
> index 1cab703..a9149fc 100644
> --- a/Documentation/git-ls-files.txt
> +++ b/Documentation/git-ls-files.txt
> @@ -57,7 +57,8 @@ OPTIONS
>  
>  -s::
>  --stage::
> -	Show staged contents' object name, mode bits and stage number in the output.
> +	Show staged contents' mode bits, hash, stage number as well as the
> +	object name in the output.

This is not an improvement, as the word "hash" is merely a
colloquial way to say what is officially known as "object name".

If the patch were only to swap "mode bits" and "object name" without
doing anything else, it may have been an improvement, though.  It is
implied that the path the output line talks about is shown, and that
is why we do not say "mode bits, object name, stage number and the
pathname".

>  
>  --directory::
>  	If a whole directory is classified as "other", show just its

[PATCH v2] Documentation: improve git ls-files -s manpage entry

[Mostyn Bramley-Moore]

List the fields in order of appearance in the command output.

Signed-off-by: Mostyn Bramley-Moore <mostyn@antipode.se>
---
 Documentation/git-ls-files.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 1cab703..d153c17 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -57,7 +57,7 @@ OPTIONS
 
 -s::
 --stage::
-	Show staged contents' object name, mode bits and stage number in the output.
+	Show staged contents' mode bits, object name and stage number in the output.
 
 --directory::
 	If a whole directory is classified as "other", show just its
-- 
2.9.3

Re: [PATCH v2] Documentation: improve git ls-files -s manpage entry

[Junio C Hamano]

Thanks.