From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: <git@vger.kernel.org>
Cc: Alan Mackenzie <acm@muc.de>
Subject: [PATCH] docs: add description of status output table
Date: Sat, 9 Jan 2021 22:06:14 +0000 [thread overview]
Message-ID: <20210109220614.759779-1-sandals@crustytoothpaste.net> (raw)
In-Reply-To: <X/oAhdZlLwcFRCrR@ACM>
The table describing the porcelain format in git-status(1) is helpful,
but it's not completely clear what the three sections mean, even to
some contributors. As a result, users are unable to find how to detect
common cases like merge conflicts programmatically.
Let's improve this situation by describing what each section means:
non-conflicted, conflicted, or untracked files.
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
---
Documentation/git-status.txt | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 7731b45f07..63f13c201d 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -201,6 +201,10 @@ codes can be interpreted as follows:
Ignored files are not listed, unless `--ignored` option is in effect,
in which case `XY` are `!!`.
+In the table below, the first section indicates normal non-conflicted states for
+tracked files, the second indicates files where a merge conflict has occurred
+but not yet been resolved, and the third indicates files not tracked by Git.
+
....
X Y Meaning
-------------------------------------------------
next prev parent reply other threads:[~2021-01-09 22:10 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-09 19:14 Difficulties of scripting git Alan Mackenzie
2021-01-09 21:42 ` brian m. carlson
2021-01-09 22:06 ` brian m. carlson [this message]
2021-01-10 1:41 ` [PATCH] docs: add description of status output table Junio C Hamano
2021-01-10 1:58 ` brian m. carlson
2021-01-10 12:28 ` Alan Mackenzie
2021-01-10 18:32 ` brian m. carlson
2021-01-10 19:04 ` [PATCH v2] docs: rephrase and clarify the git status --short format brian m. carlson
2021-01-11 20:22 ` Junio C Hamano
2021-01-16 21:45 ` brian m. carlson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210109220614.759779-1-sandals@crustytoothpaste.net \
--to=sandals@crustytoothpaste.net \
--cc=acm@muc.de \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).