Update status manpage to include information about
porcelain v2 format.
Signed-off-by: Jeff Hostetler <jeffhost@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Jeff Hostetler8 years agocommitted byJunio C Hamano
@ -183,12 +183,12 @@ in which case `XY` are `!!`.
@@ -183,12 +183,12 @@ in which case `XY` are `!!`.
If -b is used the short-format status is preceded by a line
## branchname tracking info
## 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,124 @@ field from the first filename). Third, filenames containing special
@@ -210,6 +210,124 @@ 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
~~~~~~~~~~~~~~~~~~~~~~~~~~
Version 2 format adds more detailed information about the state of
the worktree and changed items. Version 2 also defines an extensible
set of easy to parse optional headers.
Header lines start with "#" and are added in response to specific
command line arguments. Parsers should ignore headers they
don't recognize.
### Branch Headers
If `--branch` is given, a series of header lines are printed with