summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Andreas Heiduk <asheiduk@gmail.com>2018-10-22 22:45:41 +0200
committerLibravatar Junio C Hamano <gitster@pobox.com>2018-10-23 12:23:08 +0900
commite44a44aa25c5ff22334efe0bd4187b96303b00fd (patch)
tree07055f9092bc29c4fba43757660dd28d7ad5a5a1
parentGit 2.19.1 (diff)
downloadtgif-e44a44aa25c5ff22334efe0bd4187b96303b00fd.tar.xz
doc: clarify boundaries of 'git worktree list --porcelain'
Defined delimiters for 'git worktree list --porcelain' make the format easier to parse in scripts. For example sed -n '/^worktree ID$/,/^$/p' extracts only the information for the worktree 'ID'. The format did not changed since [1], only the guaranty is added. [1] bb9c03b82a (worktree: add 'list' command, 2015-10-08) Signed-off-by: Andreas Heiduk <asheiduk@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-worktree.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 29a5b7e252..d707e61198 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -262,8 +262,8 @@ Porcelain Format
The porcelain format has a line per attribute. Attributes are listed with a
label and value separated by a single space. Boolean attributes (like 'bare'
and 'detached') are listed as a label only, and are only present if and only
-if the value is true. An empty line indicates the end of a worktree. For
-example:
+if the value is true. The first attribute of a worktree is always `worktree`,
+an empty line indicates the end of the record. For example:
------------
$ git worktree list --porcelain