summaryrefslogtreecommitdiffstats
path: root/Documentation/git-status.txt
diff options
context:
space:
mode:
authorJeff Hostetler <jeffhost@microsoft.com>2016-08-06 00:00:28 +0200
committerJunio C Hamano <gitster@pobox.com>2016-08-06 00:46:42 +0200
commitc4f596b98ed305ceb594857fa34524fedc30a031 (patch)
tree9f341f925ee39be8d262794543c93769322167f6 /Documentation/git-status.txt
parentstatus: cleanup API to wt_status_print (diff)
downloadgit-c4f596b98ed305ceb594857fa34524fedc30a031.tar.xz
git-c4f596b98ed305ceb594857fa34524fedc30a031.zip
status: support --porcelain[=<version>]
Update --porcelain argument to take optional version parameter to allow multiple porcelain formats to be supported in the future. The token "v1" is the default value and indicates the traditional porcelain format. (The token "1" is an alias for that.) Signed-off-by: Jeff Hostetler <jeffhost@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-status.txt')
-rw-r--r--Documentation/git-status.txt7
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index e1e8f57cdd..6b1454bd42 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -32,11 +32,14 @@ OPTIONS
--branch::
Show the branch and tracking info even in short-format.
---porcelain::
+--porcelain[=<version>]::
Give the output in an easy-to-parse format for scripts.
This is similar to the short output, but will remain stable
across Git versions and regardless of user configuration. See
below for details.
++
+The version parameter is used to specify the format version.
+This is optional and defaults to the original version 'v1' format.
--long::
Give the output in the long-format. This is the default.
@@ -96,7 +99,7 @@ configuration variable documented in linkgit:git-config[1].
-z::
Terminate entries with NUL, instead of LF. This implies
- the `--porcelain` output format if no other format is given.
+ the `--porcelain=v1` output format if no other format is given.
--column[=<options>]::
--no-column::