[PATCH] RelNotes/1.8.5: direct script writers to "git status --porcelain"

Signed-off-by: Matthieu Moy <redacted>
---

Not terribly important, but the old item alone may sound like "we
broke your script purposely, good luck with the new version" to a
script writer.

 Documentation/RelNotes/1.8.5.txt | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/RelNotes/1.8.5.txt b/Documentation/RelNotes/1.8.5.txt
index ac5c3fa..f100a0f 100644
--- a/Documentation/RelNotes/1.8.5.txt
+++ b/Documentation/RelNotes/1.8.5.txt

@@ -96,6 +96,9 @@ UI, Workflows & Features
 
  * "git status" now omits the prefix to make its output a comment in a
    commit log editor, which is not necessary for human consumption.
+   Scripts that parse the output of "git status" are advised to use
+   "git status --porcelain", which is both easier to parse and stable,
+   instead.
 
  * Make "foo^{tag}" to peel a tag to itself, i.e. no-op., and fail if
    "foo" is not a tag.  "git rev-parse --verify v1.0^{tag}" would be

-- 
1.8.4.474.g128a96c

Matthieu Moy <Matthieu.Moy <at> imag.fr> writes:

  * "git status" now omits the prefix to make its output a comment in a
    commit log editor, which is not necessary for human consumption.
+   Scripts that parse the output of "git status" are advised to use
+   "git status --porcelain", which is both easier to parse and stable,
+   instead.

Good addition.

Perhaps "to use instead ..." would be easier to understand than
proposed "to use ..., instead." (with "..." being one line long).

-- 
Jakub Narebski.

Jakub Narebski [off-list ref] writes:

Matthieu Moy <Matthieu.Moy <at> imag.fr> writes:

quoted

  * "git status" now omits the prefix to make its output a comment in a
    commit log editor, which is not necessary for human consumption.
+   Scripts that parse the output of "git status" are advised to use
+   "git status --porcelain", which is both easier to parse and stable,
+   instead.

Good addition.

Perhaps "to use instead ..." would be easier to understand than
proposed "to use ..., instead." (with "..." being one line long).

FWIW, I find "to use instead ___" slightly stilted. I'd suggest "to
instead use", but rewording it to the following is much better, IMHO:
'... are advised to use "git status --porcelain" instead, as it is both
stable and easier to parse.'

-Keshav

Signed-off-by: Matthieu Moy <redacted>
---
Jakub Narebski [off-list ref] writes:

Perhaps "to use instead ..." would be easier to understand than
proposed "to use ..., instead." (with "..." being one line long).

Actually, I had the version below staged, but forgot to "commit
--amend" before sending. Should be clear enough.

 Documentation/RelNotes/1.8.5.txt | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/RelNotes/1.8.5.txt b/Documentation/RelNotes/1.8.5.txt
index ac5c3fa..e295266 100644
--- a/Documentation/RelNotes/1.8.5.txt
+++ b/Documentation/RelNotes/1.8.5.txt

@@ -96,6 +96,9 @@ UI, Workflows & Features
 
  * "git status" now omits the prefix to make its output a comment in a
    commit log editor, which is not necessary for human consumption.
+   Scripts that parse the output of "git status" are advised to use
+   "git status --porcelain" instead. Its format is both easier to
+   parse and stable.
 
  * Make "foo^{tag}" to peel a tag to itself, i.e. no-op., and fail if
    "foo" is not a tag.  "git rev-parse --verify v1.0^{tag}" would be

-- 
1.8.4.474.g128a96c

Keshav Kini wrote:

Jakub Narebski [off-list ref] writes:

quoted

Matthieu Moy [off-list ref] writes:

quoted

quoted

  * "git status" now omits the prefix to make its output a comment in a
    commit log editor, which is not necessary for human consumption.
+   Scripts that parse the output of "git status" are advised to use
+   "git status --porcelain", which is both easier to parse and stable,
+   instead.

Good addition.

[...]

                  rewording it to the following is much better, IMHO:
'... are advised to use "git status --porcelain" instead, as it is both
stable and easier to parse.'

Thanks, all.