From: Kristoffer Haugsbakk <code@khaugsbakk.name>
Date: Mon, 01 May 2023 20:02:37 GMT
Subject: [PATCH v4 0/4] doc: interpret-trailers: don't use deprecated config
Message-ID: <cover.1682970213.git.code@khaugsbakk.name>
In-Reply-To: <cover.1680548208.git.code@khaugsbakk.name>

Replace deprecated `command` with `cmd` (patch 3). While visiting this
file also:

• rewrite heredoc examples to use files which are shown with
  cat(1) (patch 1);
• use input redirection instead of using cat(1) piped into `git
  interpret-trailers` (patch 2); and
• fix an example that didn’t work properly (patch 4).

§ Changes in v4

• Patch 1: Use `/dev/null` instead of `empty-msg.txt`
• Patch 2: Expand commit message

Kristoffer Haugsbakk (4):
  doc: interpret-trailers: don’t use heredoc in examples
  doc: interpret-trailers: use input redirection
  doc: interpret-trailers: don’t use deprecated config
  doc: interpret-trailers: fix example

 Documentation/git-interpret-trailers.txt | 97 ++++++++++++++----------
 1 file changed, 55 insertions(+), 42 deletions(-)

Range-diff against v3:
1:  fd515ad8b4 ! 1:  149dcf964c doc: interpret-trailers: don’t use heredoc in examples
    @@ Documentation/git-interpret-trailers.txt: $ git config trailer.sign.key "Signed-
      $ git config trailer.sign.command 'echo "$(git config user.name) <$(git config user.email)>"'
     -$ git interpret-trailers <<EOF
     -> EOF
    -+$ git interpret-trailers <empty-msg.txt
    ++$ git interpret-trailers </dev/null

      Signed-off-by: Bob <bob@example.com>
     -$ git interpret-trailers <<EOF
2:  12f7b10462 ! 2:  32483aa635 doc: interpret-trailers: use input redirection
    @@ Metadata
      ## Commit message ##
         doc: interpret-trailers: use input redirection

    +    Use input redirection instead of invoking cat(1) on a single file. This
    +    is more straightforward, saves a process, and often makes the line
    +    shorter.
    +
         Suggested-by: Junio C Hamano <gitster@pobox.com>
         Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>


      ## Notes (series) ##
    -    Link: https://lore.kernel.org/git/xmqqbkk44qbo.fsf@gitster.g/
    +    Junio suggested expanding the commit message:
    +    https://lore.kernel.org/git/xmqqjzyg7qdw.fsf@gitster.g/

      ## Documentation/git-interpret-trailers.txt ##
     @@ Documentation/git-interpret-trailers.txt: $ cat msg.txt
3:  dc1982f0d0 ! 3:  9ea4c4f916 doc: interpret-trailers: don’t use deprecated config
    @@ Documentation/git-interpret-trailers.txt: $ git interpret-trailers --trailer 'Cc
      $ git config trailer.sign.ifexists doNothing
     -$ git config trailer.sign.command 'echo "$(git config user.name) <$(git config user.email)>"'
     +$ git config trailer.sign.cmd 'echo "$(git config user.name) <$(git config user.email)>"'
    - $ git interpret-trailers <empty-msg.txt
    + $ git interpret-trailers </dev/null

      Signed-off-by: Bob <bob@example.com>
     @@ Documentation/git-interpret-trailers.txt: subject
4:  f6e5605107 ! 4:  95760aafe8 doc: interpret-trailers: fix example
    @@ Documentation/git-interpret-trailers.txt: $ git interpret-trailers --trailer 'Cc
      $ 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)>"'
    --$ git interpret-trailers <empty-msg.txt
    +-$ git interpret-trailers </dev/null
     +$ git interpret-trailers --trailer sign <msg1.txt
     +subject
     +
--
2.40.1