Web lists-archives.com

[PATCH 4/4] docs/pretty-formats: add explanation + copy edits




Clarify description of %G? = "U" to say it can mean good signature but
untrusted key.

Make wording consistent between %G* placeholders and other placeholders
by removing the verb "show".

Signed-off-by: John Passaro <john.a.passaro@xxxxxxxxx>
---
 Documentation/pretty-formats.txt | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index 4a83796250..32c2f75060 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -147,18 +147,19 @@ endif::git-rev-list[]
 - '%GG': raw verification message from GPG for a signed commit.
   This and all the other %G* placeholders, other than %GR, %G+, and
   %G?, return blank if GPG cannot be run.
-- '%G?': show "G" for a good (valid) signature,
+- '%G?': "G" for a good (valid) signature,
   "B" for a bad signature,
-  "U" for a good signature with unknown validity,
+  "U" for a good signature with unknown validity (e.g. key is known but
+  not trusted),
   "X" for a good signature that has expired,
   "Y" for a good signature made by an expired key,
   "R" for a good signature made by a revoked key,
   "E" if the signature cannot be checked (e.g. missing key)
   and "N" for no signature (e.g. unsigned, or GPG cannot be run)
-- '%GS': show the name of the signer for a signed commit
-- '%GK': show the key used to sign a signed commit
-- '%GF': show the fingerprint of the key used to sign a signed commit
-- '%GP': show the fingerprint of the primary key whose subkey was used
+- '%GS': name of the signer for a signed commit
+- '%GK': key used to sign a signed commit
+- '%GF': fingerprint of the key used to sign a signed commit
+- '%GP': fingerprint of the primary key whose subkey was used
   to sign a signed commit
 - '%gD': reflog selector, e.g., `refs/stash@{1}` or
   `refs/stash@{2 minutes ago`}; the format follows the rules described
-- 
2.19.1