Re: [PATCH] git-push: fix the documentation to explain all the status flags
From: Junio C Hamano <hidden>
Date: 2016-06-15 22:48:12
Junio C Hamano [off-list ref] writes:
Unfortunately, http://www.methods.co.nz/asciidoc/newlists.html labels the syntax as "new in 8.3.0", and Debian 5.0.X and Fedora 11 both use AsciiDoc that are older than that (8.2.7 and 8.2.5). I'll flatten the description into prose for now.
Actually, we already use another syntax for nested enumerations, namely double-semicolon, in config.txt, so let's mimic that. -- >8 -- Subject: git-push: document all the status flags used by --porcelain output We didn't talk about '-' (deletion), '*' (addition), nor '+' (forced). Signed-off-by: Junio C Hamano <redacted> --- Documentation/git-push.txt | 15 ++++++++++----- 1 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index 73a921c..bd79119 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt@@ -176,12 +176,17 @@ If --porcelain is used, then each line of the output is of the form: <flag> \t <from>:<to> \t <summary> (<reason>) ------------------------------- +The status of up-to-date refs is shown only if --porcelain or --verbose +option is used. + flag:: - A single character indicating the status of the ref. This is - blank for a successfully pushed ref, `!` for a ref that was - rejected or failed to push, and '=' for a ref that was up to - date and did not need pushing (note that the status of up to - date refs is shown only when `git push` is running verbosely). + A single character indicating the status of the ref: +(space);; for a successfully pushed fast-forward; +`{plus}`;; for a successful forced update; +`-`;; for a successfully deleted ref; +`*`;; for a successfully pushed new ref; +`!`;; for a ref that was rejected or failed to push; and +`=`;; for a ref that was up to date and did not need pushing. summary:: For a successfully pushed ref, the summary shows the old and new