From: Jeff Hostetler <jeffhost@microsoft.com>
To: git@vger.kernel.org
Cc: peff@peff.net, gitster@pobox.com, jeffhost@microsoft.com
Subject: [PATCH v1 5/6] Add porcelain V2 documentation to status manpage
Date: Tue, 19 Jul 2016 18:10:57 -0400 [thread overview]
Message-ID: <1468966258-11191-6-git-send-email-jeffhost@microsoft.com> (raw)
In-Reply-To: <1468966258-11191-1-git-send-email-jeffhost@microsoft.com>
This commit updates the status manpage to include
information about porcelain format V2.
Signed-off-by: Jeff Hostetler <jeffhost@microsoft.com>
---
Documentation/git-status.txt | 62 +++++++++++++++++++++++++++++++++++++++++---
1 file changed, 59 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index de97729..01c42c0 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -185,10 +185,10 @@ If -b is used the short-format status is preceded by a line
## branchname tracking info
-Porcelain Format
-~~~~~~~~~~~~~~~~
+Porcelain Format Version 1
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-The porcelain format is similar to the short format, but is guaranteed
+Version 1 porcelain format is similar to the short format, but is guaranteed
not to change in a backwards-incompatible way between Git versions or
based on user configuration. This makes it ideal for parsing by scripts.
The description of the short format above also describes the porcelain
@@ -210,6 +210,62 @@ field from the first filename). Third, filenames containing special
characters are not specially formatted; no quoting or
backslash-escaping is performed.
+Porcelain Format Version 2
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+If `--branch` is given, a header line showing branch tracking information
+is printed. This line begins with "### branch: ". Fields are separated
+by a single space.
+
+ Field Meaning
+ --------------------------------------------------------
+ <sha> | (initial) Current commit
+ <branch> | (detached) Current branch
+ <upstream> Upstream branch, if set
+ +<ahead> Ahead count, if upstream present
+ -<behind> Behind count, if upstream present
+ --------------------------------------------------------
+
+A series of lines are then displayed for the tracked entries.
+
+ <xy> <sub> <mA> <mB> <mC> <mD> <shaA> <shaB> <shaC> R<nr> <path>[\t<pathSrc>]
+
+ Field Meaning
+ --------------------------------------------------------
+ <xy> The staged and unstaged values described earlier, with
+ unchanged indicated by a "." rather than a space.
+ <sub> The submodule state. "N" when the entry is not a submodule.
+ "S[C][M][U]" when the entry is a submodule.
+ "C" indicates the submodule commit has changed.
+ "M" indicates the submodule has tracked changes.
+ "U" indicates the submodule has untracked changes.
+ <m*> The file modes for the entry.
+ For unmerged entries, these are the stage 1, 2, and 3,
+ and the worktree modes.
+ For regular entries, these are the head, index, and
+ worktree modes; the fourth is zero.
+ <sha*> The SHA1 values for the entry.
+ For unmerged entries, these are the stage 1,2, and 3 values.
+ For regular entries, these are the head and index values;
+ the third entry is zero.
+ R<nr> The rename percentage score.
+ <path> The current pathname. It is C-Quoted if necessary.
+ <pathSrc> The original path. This is only present for staged renames.
+ It is C-Quoted if necessary.
+ --------------------------------------------------------
+
+A series of lines are then displayed for untracked and ignored entries.
+
+ <xx> <path>
+
+Where <xx> is "??" for untracked entries and "!!" for ignored entries.
+
+When the `-z` option is given, a NUL (zero) byte follows each pathname;
+serving as both a separator and line termination. No pathname quoting
+or backslash escaping is performed. All fields are output in the same
+order.
+
CONFIGURATION
-------------
--
2.8.0.rc4.17.gac42084.dirty
next prev parent reply other threads:[~2016-07-19 22:13 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-19 22:10 [PATCH v1 0/6] Porcelain Status V2 Jeff Hostetler
2016-07-19 22:10 ` [PATCH v1 1/6] Allow --porcelain[=<n>] in status and commit commands Jeff Hostetler
2016-07-20 15:08 ` Johannes Schindelin
2016-07-20 15:38 ` Jeff Hostetler
2016-07-21 14:28 ` Johannes Schindelin
2016-07-20 15:58 ` Jeff King
2016-07-20 17:26 ` Jeff Hostetler
2016-07-20 20:46 ` Junio C Hamano
2016-07-19 22:10 ` [PATCH v1 2/6] Status and checkout unit tests for --porcelain[=<n>] Jeff Hostetler
2016-07-20 15:19 ` Johannes Schindelin
2016-07-20 15:51 ` Jeff Hostetler
2016-07-20 16:00 ` Jeff King
2016-07-20 16:03 ` Jeff King
2016-07-20 17:31 ` Jeff Hostetler
2016-07-20 17:29 ` Jeff Hostetler
2016-07-19 22:10 ` [PATCH v1 3/6] Per-file output for Porcelain Status V2 Jeff Hostetler
2016-07-20 20:50 ` Junio C Hamano
2016-07-21 14:19 ` Johannes Schindelin
2016-07-20 21:31 ` Junio C Hamano
2016-07-21 18:58 ` Jeff Hostetler
2016-07-22 17:01 ` Junio C Hamano
2016-07-19 22:10 ` [PATCH v1 4/6] Expanded branch header " Jeff Hostetler
2016-07-20 16:06 ` Jeff King
2016-07-20 18:20 ` Jeff Hostetler
2016-07-20 20:54 ` Jeff King
2016-07-21 15:46 ` Johannes Schindelin
2016-07-21 19:03 ` Jeff Hostetler
2016-07-19 22:10 ` Jeff Hostetler [this message]
2016-07-20 15:29 ` [PATCH v1 5/6] Add porcelain V2 documentation to status manpage Jakub Narębski
2016-07-20 15:42 ` Jeff Hostetler
2016-07-20 15:55 ` Jakub Narębski
2016-07-20 21:50 ` Junio C Hamano
2016-07-19 22:10 ` [PATCH v1 6/6] Unit tests for V2 porcelain status Jeff Hostetler
2016-07-20 15:30 ` Jakub Narębski
2016-07-20 15:47 ` Jeff Hostetler
2016-07-20 16:01 ` Jakub Narębski
2016-07-21 15:54 ` Johannes Schindelin
2016-07-20 16:15 ` [PATCH v1 0/6] Porcelain Status V2 Jeff King
2016-07-20 19:27 ` Jeff Hostetler
2016-07-20 20:57 ` Jeff King
2016-07-21 16:02 ` Johannes Schindelin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1468966258-11191-6-git-send-email-jeffhost@microsoft.com \
--to=jeffhost@microsoft.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).