git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH 0/1] git status docs.
@ 2018-02-15  0:18 Stefan Beller
  2018-02-15  0:18 ` [PATCH 1/1] Documentation/git-status: clarify status table for porcelain mode Stefan Beller
  0 siblings, 1 reply; 3+ messages in thread
From: Stefan Beller @ 2018-02-15  0:18 UTC (permalink / raw)
  To: git; +Cc: Stefan Beller

A user complained about the inaccurate documentation of `git-status --porcelain`.
Fix the table showing the states.

I found e92e9cd3c3 (Documentation improvements for the description
of short format., 2010-04-23) which also linked to 
https://public-inbox.org/git/20100410040959.GA11977@coredump.intra.peff.net/

Stefan Beller (1):
  Documentation/git-status: clarify status table for porcelain mode

 Documentation/git-status.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

-- 
2.16.1.291.g4437f3f132-goog


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH 1/1] Documentation/git-status: clarify status table for porcelain mode
  2018-02-15  0:18 [PATCH 0/1] git status docs Stefan Beller
@ 2018-02-15  0:18 ` Stefan Beller
  2018-02-15 19:07   ` Junio C Hamano
  0 siblings, 1 reply; 3+ messages in thread
From: Stefan Beller @ 2018-02-15  0:18 UTC (permalink / raw)
  To: git; +Cc: Stefan Beller

It is possible to have the output ' A' from 'git status --porcelain'
by adding a file using the '--intend-to-add' flag.  Make this clear by
adding the pattern in the table of the documentation.

However the mode 'DM' (deleted in the index, modified in the working tree)
is not possible in the non-merge case in which the file only shows
as 'D ' (and adding it back to the worktree would show an additional line
of an '??' untracked file). It is also not possible in the merge case as
then the mode involves a 'U' on one side of the merge.
Remove that pattern.

Reported-by: Ross Light <light@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
---
 Documentation/git-status.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 72bfb87f66..de69035cca 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -184,10 +184,10 @@ in which case `XY` are `!!`.
 
     X          Y     Meaning
     -------------------------------------------------
-              [MD]   not updated
+             [AMD]   not updated
     M        [ MD]   updated in index
     A        [ MD]   added to index
-    D         [ M]   deleted from index
+    D                deleted from index
     R        [ MD]   renamed in index
     C        [ MD]   copied in index
     [MARC]           index and work tree matches
-- 
2.16.1.291.g4437f3f132-goog


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH 1/1] Documentation/git-status: clarify status table for porcelain mode
  2018-02-15  0:18 ` [PATCH 1/1] Documentation/git-status: clarify status table for porcelain mode Stefan Beller
@ 2018-02-15 19:07   ` Junio C Hamano
  0 siblings, 0 replies; 3+ messages in thread
From: Junio C Hamano @ 2018-02-15 19:07 UTC (permalink / raw)
  To: Stefan Beller; +Cc: git

Stefan Beller <sbeller@google.com> writes:

> It is possible to have the output ' A' from 'git status --porcelain'
> by adding a file using the '--intend-to-add' flag.  Make this clear by
> adding the pattern in the table of the documentation.
>
> However the mode 'DM' (deleted in the index, modified in the working tree)
> is not possible in the non-merge case in which the file only shows
> as 'D ' (and adding it back to the worktree would show an additional line

Correct.  Thanks, will queue.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2018-02-15 19:07 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-02-15  0:18 [PATCH 0/1] git status docs Stefan Beller
2018-02-15  0:18 ` [PATCH 1/1] Documentation/git-status: clarify status table for porcelain mode Stefan Beller
2018-02-15 19:07   ` Junio C Hamano

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).