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>
Andreas Heiduk committed
Oct 22, 2018 at 22:45 UTC
e44a44aa25c5ff22334efe0bd4187b96303b00fd
1 file changed
+2
-2
Documentation/git-worktree.txt
+2
-2
@@ -262,8 +262,8 @@ Porcelain Format
262
The porcelain format has a line per attribute. Attributes are listed with a
263
label and value separated by a single space. Boolean attributes (like 'bare'
264
and 'detached') are listed as a label only, and are only present if and only
265
-if the value is true. An empty line indicates the end of a worktree. For
266
-example:
265
+if the value is true. The first attribute of a worktree is always `worktree`,
266
+an empty line indicates the end of the record. For example:
267
268
------------
269
$ git worktree list --porcelain