From: Kristoffer Haugsbakk <code@khaugsbakk.name>
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>,
rybak.a.v@gmail.com, Christian Couder <chriscool@tuxfamily.org>
Subject: [PATCH v2 3/3] doc: interpret-trailers: fix examples
Date: Mon, 3 Apr 2023 21:22:01 +0200 [thread overview]
Message-ID: <14555cf87fa5fdc0ce14c7077ba212d16ad3bc76.1680548650.git.code@khaugsbakk.name> (raw)
In-Reply-To: <cover.1680548650.git.code@khaugsbakk.name>
We need to provide `--trailer sign` since the command won’t output
anything if you don’t give it an input and/or a
`--trailer`. Furthermore, the example where `msg.txt` already contains
an s-o-b is wrong:
$ cat msg.txt | git interpret-trailers --trailer sign
Signed-off-by: Alice <alice@example.com>
Signed-off-by: Alice <alice@example.com>
A file which only consists of one trailer line is not interpreted as the
original example must have expected. So change the examples to use the
typical “subject/message” file.
Cc: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
This isn’t just a quirk of this series but also happens on `master`:
$ git config trailer.sign.ifmissing add
$ git config trailer.sign.ifexists doNothing
$ git config trailer.sign.command 'echo "$(git config user.name) <$(git config user.email)>"'
$ git interpret-trailers <<EOF
> EOF
$ git interpret-trailers <<EOF
Signed-off-by: Alice <alice@example.com>
> EOF
Signed-off-by: Alice <alice@example.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Documentation/git-interpret-trailers.txt | 20 +++++++++++++++++---
1 file changed, 17 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index c76efae76a..c6f5b92ecc 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -322,16 +322,30 @@ $ git interpret-trailers --trailer 'Cc: Alice <alice@example.com>' --trailer 'Re
'Signed-off-by: ' already, and show how it works:
+
------------
+$ cat msg1.txt
+subject
+
+message
$ git config trailer.sign.key "Signed-off-by: "
$ git config trailer.sign.ifmissing add
$ git config trailer.sign.ifexists doNothing
$ git config trailer.sign.cmd 'echo "$(git config user.name) <$(git config user.email)>"'
-$ cat empty-msg.txt | git interpret-trailers
+$ cat msg1.txt | git interpret-trailers --trailer sign
+subject
+
+message
Signed-off-by: Bob <bob@example.com>
-$ cat msg.txt
+$ cat msg2.txt
+subject
+
+message
+
Signed-off-by: Alice <alice@example.com>
-$ cat msg.txt | git interpret-trailers
+$ cat msg2.txt | git interpret-trailers --trailer sign
+subject
+
+message
Signed-off-by: Alice <alice@example.com>
------------
--
2.40.0
next prev parent reply other threads:[~2023-04-03 19:24 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20230331180817.14466-1-code@khaugsbakk.name>
2023-03-31 18:12 ` [PATCH 1/3] doc: interpret-trailers: remove trailing spaces Kristoffer Haugsbakk
2023-03-31 18:21 ` Kristoffer Haugsbakk
2023-03-31 18:28 ` Kristoffer Haugsbakk
2023-03-31 18:46 ` Junio C Hamano
2023-03-31 19:05 ` Junio C Hamano
2023-04-03 19:21 ` [PATCH v2 0/3] doc: interpret-trailers: don't use deprecated config Kristoffer Haugsbakk
2023-04-12 19:52 ` [PATCH v3 0/4] " Kristoffer Haugsbakk
2023-04-12 19:52 ` [PATCH v3 1/4] doc: interpret-trailers: don’t use heredoc in examples Kristoffer Haugsbakk
2023-04-12 21:16 ` Junio C Hamano
2023-04-12 19:52 ` [PATCH v3 2/4] doc: interpret-trailers: use input redirection Kristoffer Haugsbakk
2023-04-12 21:16 ` Junio C Hamano
2023-04-12 19:52 ` [PATCH v3 3/4] doc: interpret-trailers: don’t use deprecated config Kristoffer Haugsbakk
2023-04-12 19:52 ` [PATCH v3 4/4] doc: interpret-trailers: fix example Kristoffer Haugsbakk
2023-04-12 21:16 ` [PATCH v3 0/4] doc: interpret-trailers: don't use deprecated config Junio C Hamano
2023-05-01 20:02 ` [PATCH v4 " Kristoffer Haugsbakk
2023-05-01 20:02 ` [PATCH v4 1/4] doc: interpret-trailers: don’t use heredoc in examples Kristoffer Haugsbakk
2023-05-01 20:02 ` [PATCH v4 2/4] doc: interpret-trailers: use input redirection Kristoffer Haugsbakk
2023-05-01 20:02 ` [PATCH v4 3/4] doc: interpret-trailers: don’t use deprecated config Kristoffer Haugsbakk
2023-05-01 20:02 ` [PATCH v4 4/4] doc: interpret-trailers: fix example Kristoffer Haugsbakk
2023-05-01 20:59 ` [PATCH v4 0/4] doc: interpret-trailers: don't use deprecated config Junio C Hamano
[not found] ` <cover.1680548650.git.code@khaugsbakk.name>
2023-04-03 19:21 ` [PATCH v2 1/3] doc: interpret-trailers: don’t use heredoc in examples Kristoffer Haugsbakk
2023-04-03 20:16 ` Junio C Hamano
2023-04-03 19:22 ` [PATCH v2 2/3] doc: interpret-trailers: don’t use deprecated config Kristoffer Haugsbakk
2023-04-03 21:18 ` Junio C Hamano
2023-04-04 18:02 ` Kristoffer Haugsbakk
2023-04-04 18:37 ` Junio C Hamano
2023-04-05 7:46 ` ZheNing Hu
2023-04-05 7:45 ` ZheNing Hu
2023-04-05 9:09 ` Kristoffer Haugsbakk
2023-04-03 19:22 ` Kristoffer Haugsbakk [this message]
2023-03-31 18:14 ` [PATCH " Kristoffer Haugsbakk
2023-04-01 0:22 ` Andrei Rybak
2023-03-31 18:16 ` [PATCH 3/3] doc: interpret-trailers: fix example Kristoffer Haugsbakk
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=14555cf87fa5fdc0ce14c7077ba212d16ad3bc76.1680548650.git.code@khaugsbakk.name \
--to=code@khaugsbakk.name \
--cc=chriscool@tuxfamily.org \
--cc=git@vger.kernel.org \
--cc=rybak.a.v@gmail.com \
/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.
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 NNTP newsgroup(s).