From patchwork Thu Jun 15 02:53:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13280656 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id BF383EB64D8 for ; Thu, 15 Jun 2023 02:53:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S242535AbjFOCx4 (ORCPT ); Wed, 14 Jun 2023 22:53:56 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39892 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234621AbjFOCxz (ORCPT ); Wed, 14 Jun 2023 22:53:55 -0400 Received: from mail-wr1-x42f.google.com (mail-wr1-x42f.google.com [IPv6:2a00:1450:4864:20::42f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0653F26AF for ; Wed, 14 Jun 2023 19:53:53 -0700 (PDT) Received: by mail-wr1-x42f.google.com with SMTP id ffacd0b85a97d-31110aea814so736922f8f.2 for ; Wed, 14 Jun 2023 19:53:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686797632; x=1689389632; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=eKnHkWHPlF4MPLsuzOkdEOFk4KoJE6veAx4v7vS/i/8=; b=JPlZAASeyBO/51qwuMlrI2vviVYkYj6ZbG3mspeYK+RhFLhk6ogM5a9909DsMz6ul0 TuRGPP7mPNRBNGOTK4S1upKHzEkp4p5yQ/qmagDCY8Q7rRK1JBTuaO0A0hZD1Tf3i42d K6OApTQwjvdRBbAhpkgEfVM05XlwsQqDPWB061qt4gPj5KG4ApEmI8By46YN0XkDbcDk lNa0wZ4wgBN44jkjcD+Fv3TLb+EagTZkik5IOmbFVmUPmZ7OokJLAB0aV7xfW1m9GkXj 7WXL4hGVFhSxS53BT6jyRmnfje9amgodixxy7Xkv8hbESQUfW3RW/n1VxSOxBUWIE6Mq EDaw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686797632; x=1689389632; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=eKnHkWHPlF4MPLsuzOkdEOFk4KoJE6veAx4v7vS/i/8=; b=aN8LEcEGL4nNlmphvgr8wdx6TtpD3muNu4OYjDZugDGWEI7ieWqtN3h6YxeUSlRboQ Sl5+UgQxQCqnk0PHaELVqF9D0ve9TMI6OvXOHAFD7J0KP/ERJP+hT56b11pQR/nISXt+ gdEBRK+Ya7d2A2RmQKAWVR86rtVZJp94CU8lOVxE/p0IqwXybsTanOPobVBeWkiDl08P WRlemyDitCLX9an7hVjZ1qWWCTRP1PV/ugF3fQptE6dtG95WSUYwZyfZl/VZ9MfzgB7L NL0/hjamcafM7Mw+0ql1MOtl+OyYzty0Zs6t4d4K8lSVvYM77udxkktqKsdGQ6T2Uz3C HRug== X-Gm-Message-State: AC+VfDy9HTovPwkMecEYBH7/o1yriskQ8iSM46lnNxAfklDMfkEi5JUM FHQsHy/VpYJ5p4DBJ6O2L/pMT04iDcQ= X-Google-Smtp-Source: ACHHUZ7tUlc21tASm/fdj3Q1kHidoMM2oHcU6ugKDQsmXbdoq2oJ5x4u1AprrF2omREujEedEUfxnA== X-Received: by 2002:a05:6000:1089:b0:311:143c:7bd1 with SMTP id y9-20020a056000108900b00311143c7bd1mr575665wrw.49.1686797632049; Wed, 14 Jun 2023 19:53:52 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id h14-20020a5d6e0e000000b003078354f774sm19582405wrz.36.2023.06.14.19.53.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jun 2023 19:53:51 -0700 (PDT) Message-Id: <7d504700b91c175c952a16f0d82e642393ce7c84.1686797630.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 15 Jun 2023 02:53:42 +0000 Subject: [PATCH v4 1/9] doc: trailer: fix grammar Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , Linus Arver , Linus Arver Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Linus Arver From: Linus Arver Signed-off-by: Linus Arver --- Documentation/git-interpret-trailers.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 4b97f812be8..35faf837892 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION ----------- -Help parsing or adding 'trailers' lines, that look similar to RFC 822 e-mail +Parse or add 'trailer' lines that look similar to RFC 822 e-mail headers, at the end of the otherwise free-form part of a commit message. @@ -249,10 +249,10 @@ for the same , 'trailer..cmd' is used and 'trailer..command' is ignored. trailer..cmd:: - This option can be used to specify a shell command that will be called: + This option can be used to specify a shell command that will be called once to automatically add a trailer with the specified , and then - each time a '--trailer =' argument to modify the of - the trailer that this option would produce. + called each time a '--trailer =' argument is specified to + modify the of the trailer that this option would produce. + When the specified command is first called to add a trailer with the specified , the behavior is as if a special From patchwork Thu Jun 15 02:53:43 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13280658 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6B019EB64D8 for ; Thu, 15 Jun 2023 02:54:01 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S242614AbjFOCyA (ORCPT ); Wed, 14 Jun 2023 22:54:00 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39920 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S242529AbjFOCx4 (ORCPT ); Wed, 14 Jun 2023 22:53:56 -0400 Received: from mail-wm1-x330.google.com (mail-wm1-x330.google.com [IPv6:2a00:1450:4864:20::330]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BA03B26B1 for ; Wed, 14 Jun 2023 19:53:54 -0700 (PDT) Received: by mail-wm1-x330.google.com with SMTP id 5b1f17b1804b1-3f8c74af64fso12978915e9.1 for ; Wed, 14 Jun 2023 19:53:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686797633; x=1689389633; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=Ue53EZBCMKFJaY0oPdIPR+2S73vx8SmmOg6dfRJBTj0=; b=kF6Gol6Kb7Zlmt+A4YwbyybcWNCEnZdxDH/K+MwUnP/C40Rn/yE8iduzJ5IbqmFllW Xp2pKiru1wNolB7I6bvlI5MCNHgItSQI3agwI4t/P6Er8ckKUmXQ6Z9/mM0bLTO7COfD kwbNKLw/4GWEuxWxik/ptGDP7JjdqSHbbUaK42rFB9Wr8vpQ2/qvz3td0TUuGEE9Qmob 6ZGzrfMotbSons0XIDWTclCSR5F4p7IkGp3amcrohNzejrAVmbCsFhd6lGfORF5mawIj DBLGwO06GDShPSzSv8D7roh2oDI3XO+1Hj7FW8ON1dVNkux6WSlnpMaA/IfmHvlak3Z8 YpTQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686797633; x=1689389633; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Ue53EZBCMKFJaY0oPdIPR+2S73vx8SmmOg6dfRJBTj0=; b=SEHn05OXdhJfJpKfPo2fPJGOUdZx4KVYHbrBGkyeubNwYGa5jBE5EiPYHcQjNdvzs5 XAxyuT/PGQQuQTKWAkWBP3s9g673/yiR36HxoPD1wStPxwwEwd1TqmNm8Gic1SB1ie/B G79dpBGfZghMl/CHddiT1oqlHjKNVfkjnnWVA6OPYbnqGuOnruIlRT0PvL1Tc0slhDfd lf4bQ7N/HhghjGBSowBSGuUw6IJL7ebLnDU0DC7wZphz0K7TaVTEtdWphKIWGe0ABejE UlZcKw/yiRqbF62y+agB+LqRtUVA0dDDWSIkAG20y9pZQGSF06lF7lSmwhAxNX5/5MEz loCw== X-Gm-Message-State: AC+VfDwALX+7mPps5R/egWz/6Q2DI94R//xuKp+uiqa/DfsIurcRog0D ETIiWsOUN70tthIgJUp1WUjdAHczodM= X-Google-Smtp-Source: ACHHUZ4Ddvyu/barebCkEmpfuAJka/DqyxakDmMBUkyPXXJ9U/JbLTUl2vdifIbk3f6c9wyxjEYduA== X-Received: by 2002:a5d:534a:0:b0:311:112d:eaeb with SMTP id t10-20020a5d534a000000b00311112deaebmr906022wrv.33.1686797632933; Wed, 14 Jun 2023 19:53:52 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id q3-20020adff503000000b002ca864b807csm19708822wro.0.2023.06.14.19.53.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jun 2023 19:53:52 -0700 (PDT) Message-Id: <65386432ca4a8a41acdb4f061a8ca6a8f02d289b.1686797630.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 15 Jun 2023 02:53:43 +0000 Subject: [PATCH v4 2/9] doc: trailer: swap verb order Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , Linus Arver , Linus Arver Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Linus Arver From: Linus Arver This matches the order already used in the NAME section. Signed-off-by: Linus Arver --- Documentation/git-interpret-trailers.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 35faf837892..da8fec7d5fe 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION ----------- -Parse or add 'trailer' lines that look similar to RFC 822 e-mail +Add or parse 'trailer' lines that look similar to RFC 822 e-mail headers, at the end of the otherwise free-form part of a commit message. From patchwork Thu Jun 15 02:53:44 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13280659 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id C645AEB64DB for ; Thu, 15 Jun 2023 02:54:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234708AbjFOCyB (ORCPT ); Wed, 14 Jun 2023 22:54:01 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39926 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230373AbjFOCx5 (ORCPT ); Wed, 14 Jun 2023 22:53:57 -0400 Received: from mail-wm1-x331.google.com (mail-wm1-x331.google.com [IPv6:2a00:1450:4864:20::331]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E2CAE26A0 for ; Wed, 14 Jun 2023 19:53:55 -0700 (PDT) Received: by mail-wm1-x331.google.com with SMTP id 5b1f17b1804b1-3f8d0d684f3so12908315e9.2 for ; Wed, 14 Jun 2023 19:53:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686797634; x=1689389634; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=39VXbuFirTo9uhsb874geNnZ+aer6eAP80SdCvcwMMg=; b=EcmJBtSE/q6Q3kSPrhD3Q2rOQqvzOYpJI+7lPkuo6RpNyKUEuejGcCc+5Xc/bVAcnl XPT7F6uYRZ4LNtXvFRXCspl2D17DDIk4vFK7Z5SVSar5KVo+PfEXURbuFQLJg7wVklea uaiKxC5uWwCsQdc4DBwaZg2FlSN6op/BPt3alAwHfIJ4FQKwRdMMeJrjITwGtwI1wWy6 MaKulFVWm4bwKqSixL1wMyRhlTrT2jtLwztAN2uykw0LMRUt4diUn77NM6j68LtFJ2zy X6LBidZVTEboz0zw2kuKXLbqPGji0OwUyiRrx7R26mR+6sNAxDoV8uR95eSXxW5Ifwgf AV+A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686797634; x=1689389634; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=39VXbuFirTo9uhsb874geNnZ+aer6eAP80SdCvcwMMg=; b=hFO0MCuFzC3LL4v/fMdLz1rhR4xAukksRDvI/G9JDiGA0sgQwECTMb3uLbp7aDGwUq KN158cdXi9U3xZmgppyERJabA3xoe+Rvmv4+kJoFnfNFiHxpaACRTIlV8nqGkRZjAiVH sUl6vW/2EYV6nLXk6pyeaB5d5E0JweHBJBBaLW9158fB4YWBTOB2XNrz5olsY5lFFNOS 6u7T6rZFlrIV9mFpMUxCTrvH6JhcZbhkmSMB2Ly8ir0AUZCy9yG67gcl72gbDZb6olKr A34iDtaJHGIaPmT4v0ah7KCnwEACDcOyCgDXj0rKuX0Rs6KxbLGbPcfLMBOuHMZUdgUr hgbA== X-Gm-Message-State: AC+VfDxApRGyL/+niq9YMW2y0UhD4InuGBAi8t1v08Bt8r1eFTW6YvzE oIoTlP8sXYeLlyj4jtNXtqgdA2UuyOs= X-Google-Smtp-Source: ACHHUZ4qLprDK0uFW/jNh0ilihYBQvAnkrCcThQGREFUoBNj0N+5fMLzYKZoO0UnJOGVl3Bk//xkCg== X-Received: by 2002:a1c:f70a:0:b0:3f7:3280:810b with SMTP id v10-20020a1cf70a000000b003f73280810bmr12241493wmh.19.1686797633895; Wed, 14 Jun 2023 19:53:53 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id h4-20020a05600c314400b003f1978bbcd6sm1340526wmo.3.2023.06.14.19.53.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jun 2023 19:53:53 -0700 (PDT) Message-Id: <3c85477d791d04b063e1f041c138c307e0ee495f.1686797630.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 15 Jun 2023 02:53:44 +0000 Subject: [PATCH v4 3/9] doc: trailer: drop "commit message part" phrasing Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , Linus Arver , Linus Arver Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Linus Arver From: Linus Arver The command can take inputs that are either just a commit message, or an email-like output such as git-format-patch which includes a commit message, "---" divider, and patch part. The existing explanation blends these two inputs together in the first sentence This command reads some patches or commit messages which then necessitates using the "commit message part" phrasing (as opposed to just "commit message") because the input is ambiguous per the above definition. This change separates the two input types and explains them separately, and so there is no longer a need to use the "commit message part" phrase. Signed-off-by: Linus Arver --- Documentation/git-interpret-trailers.txt | 36 +++++++++++++----------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index da8fec7d5fe..d0a0b303880 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -18,17 +18,23 @@ Add or parse 'trailer' lines that look similar to RFC 822 e-mail headers, at the end of the otherwise free-form part of a commit message. -This command reads some patches or commit messages from either the - arguments or the standard input if no is specified. If -`--parse` is specified, the output consists of the parsed trailers. - +This command reads commit messages from either the + arguments or the standard input if no is specified. +If `--parse` is specified, the output consists of the parsed trailers. Otherwise, this command applies the arguments passed using the -`--trailer` option, if any, to the commit message part of each input -file. The result is emitted on the standard output. +`--trailer` option, if any, to each input file. The result is emitted on the +standard output. + +This command can also operate on the output of linkgit:git-format-patch[1], +which is more elaborate than a plain commit message. Namely, such output +includes a commit message (as above), a "---" divider line, and a patch part. +For these inputs, the divider and patch parts are not modified by +this command and are emitted as is on the output, unless +`--no-divider` is specified. Some configuration variables control the way the `--trailer` arguments -are applied to each commit message and the way any existing trailer in -the commit message is changed. They also make it possible to +are applied to each input and the way any existing trailer in +the input is changed. They also make it possible to automatically add some trailers. By default, a '=' or ':' argument given @@ -36,7 +42,7 @@ using `--trailer` will be appended after the existing trailers only if the last trailer has a different (, ) pair (or if there is no existing trailer). The and parts will be trimmed to remove starting and trailing whitespace, and the resulting trimmed - and will appear in the message like this: + and will appear in the output like this: ------------------------------------------------ token: value @@ -47,19 +53,17 @@ This means that the trimmed and will be separated by By default the new trailer will appear at the end of all the existing trailers. If there is no existing trailer, the new trailer will appear -after the commit message part of the output, and, if there is no line -with only spaces at the end of the commit message part, one blank line -will be added before the new trailer. +at the end of the input. A blank line will be added before the new +trailer if there isn't one already. -Existing trailers are extracted from the input message by looking for +Existing trailers are extracted from the input by looking for a group of one or more lines that (i) is all trailers, or (ii) contains at least one Git-generated or user-configured trailer and consists of at least 25% trailers. The group must be preceded by one or more empty (or whitespace-only) lines. -The group must either be at the end of the message or be the last +The group must either be at the end of the input or be the last non-whitespace lines before a line that starts with '---' (followed by a -space or the end of the line). Such three minus signs start the patch -part of the message. See also `--no-divider` below. +space or the end of the line). When reading trailers, there can be no whitespace before or inside the token, but any number of regular space and tab characters are allowed From patchwork Thu Jun 15 02:53:45 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13280661 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A80E7EB64D8 for ; Thu, 15 Jun 2023 02:54:08 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S242697AbjFOCyH (ORCPT ); Wed, 14 Jun 2023 22:54:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39920 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S242564AbjFOCx6 (ORCPT ); Wed, 14 Jun 2023 22:53:58 -0400 Received: from mail-wr1-x42a.google.com (mail-wr1-x42a.google.com [IPv6:2a00:1450:4864:20::42a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7E48B26A9 for ; Wed, 14 Jun 2023 19:53:56 -0700 (PDT) Received: by mail-wr1-x42a.google.com with SMTP id ffacd0b85a97d-30fb7be435dso3654491f8f.1 for ; Wed, 14 Jun 2023 19:53:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686797634; x=1689389634; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=3Qqv650L8XotgZ0aR4Jqb6NGuW3Hg6cdUtqyWLiBjzU=; b=BE2248QGrKlDAvFm9MxkCySzLJaMU8axaZoSVG2s107qScw9hwPAY9Ycc9NqqdDjvT OM9o1CXuF8HK3Cq/Z25VqZkgq9NID2wiQ1AXz7JonsPB3rMFcm6nFsYWDWhvuUqsozi6 ONoxYLVIdLGCUd11tmozh0UxpqsE457F8XaXhtUMTe6oRKQ/WhkdF0caT36lhkwIxYM3 tCm+I/o0yDEsv4vaM7+Lt42a7MMTp3HBXKrt+GFr9SWFxOuHppeojErq5itSFhSnQ1ZK LkDaNGsZ2QA5SW6U7P7WO/2fikaQkUpyfiW37++qQTQANmMd7ShK2N/4kVmuXJOKwO6k pAtA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686797634; x=1689389634; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=3Qqv650L8XotgZ0aR4Jqb6NGuW3Hg6cdUtqyWLiBjzU=; b=lv4rz14lDvyfYMwsfw8HFmb5DujPe/X2+it4H1qDC495Bqd2knqHyulai27/WH81+e euTrCOWpsUtvlew2b44LNyiaggSONsu5tFC0gf1kjumPzEyYEPtXO8lAzoH+TInbuHvp T8+Gh4GcH4K3JyPcyyn8cT6QIVLl6zeGnWw1mBvMkzQc2F23TePcS4Ut5vZHvtfk52id Py5yO5R2A6gcUjLK8yby1UtHY19MTlyD9ZWvCa81mD/WaZma2vzbp4uePagWniUGLQpT hoUL5dNwM927fpSwEHMs10S6HNBl1MOJSiD7CQEwZ7TyF6Cv5Ur/IWPKvJ/GHwT4hVC6 AhRQ== X-Gm-Message-State: AC+VfDyMBeuYVCE3b25wi5cjt6a8XNJaLvmRBD78lHopKkRYMugFMfL1 usTQ0HxTikl/QtC7ceDwoI+hkAn+kFk= X-Google-Smtp-Source: ACHHUZ7lqKBrR02G/8tVsN14I7n/5mfLBwHPG27pG1D0Zlad9iaHM1nh3UJ59jR2rgu7TT07dyMLFg== X-Received: by 2002:a5d:484f:0:b0:30f:ca58:39ca with SMTP id n15-20020a5d484f000000b0030fca5839camr5933167wrs.31.1686797634499; Wed, 14 Jun 2023 19:53:54 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p4-20020a5d48c4000000b0030903d44dbcsm19593274wrs.33.2023.06.14.19.53.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jun 2023 19:53:54 -0700 (PDT) Message-Id: <6b4cb31b17077181a311ca87e82464a1e2ad67dd.1686797630.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 15 Jun 2023 02:53:45 +0000 Subject: [PATCH v4 4/9] doc: trailer: examples: avoid the word "message" by itself Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , Linus Arver , Linus Arver Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Linus Arver From: Linus Arver Previously, "message" could mean the input, output, commit message, or "internal body text inside the commit message" (in the EXAMPLES section). Avoid overloading this term by using the appropriate meanings explicitly. Signed-off-by: Linus Arver --- Documentation/git-interpret-trailers.txt | 50 ++++++++++++------------ 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index d0a0b303880..58a9c691492 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -83,12 +83,12 @@ OPTIONS --trim-empty:: If the part of any trailer contains only whitespace, - the whole trailer will be removed from the resulting message. + the whole trailer will be removed from the output. This applies to existing trailers as well as new trailers. --trailer [(=|:)]:: Specify a (, ) pair that should be applied as a - trailer to the input messages. See the description of this + trailer to the inputs. See the description of this command. --where :: @@ -102,7 +102,7 @@ OPTIONS --if-exists :: --no-if-exists:: Specify what action will be performed when there is already at - least one trailer with the same in the message. A setting + least one trailer with the same in the input. A setting provided with '--if-exists' overrides all configuration variables and applies to all '--trailer' options until the next occurrence of '--if-exists' or '--no-if-exists'. Possible actions are `addIfDifferent`, @@ -111,7 +111,7 @@ OPTIONS --if-missing :: --no-if-missing:: Specify what action will be performed when there is no other - trailer with the same in the message. A setting + trailer with the same in the input. A setting provided with '--if-missing' overrides all configuration variables and applies to all '--trailer' options until the next occurrence of '--if-missing' or '--no-if-missing'. Possible actions are `doNothing` @@ -178,7 +178,7 @@ first trailer with the same . trailer.ifexists:: This option makes it possible to choose what action will be performed when there is already at least one trailer with the - same in the message. + same in the input. + The valid values for this option are: `addIfDifferentNeighbor` (this is the default), `addIfDifferent`, `add`, `replace` or `doNothing`. @@ -188,10 +188,10 @@ trailer with the same (, ) pair is above or below the line where the new trailer will be added. + With `addIfDifferent`, a new trailer will be added only if no trailer -with the same (, ) pair is already in the message. +with the same (, ) pair is already in the input. + With `add`, a new trailer will be added, even if some trailers with -the same (, ) pair are already in the message. +the same (, ) pair are already in the input. + With `replace`, an existing trailer with the same will be deleted and the new trailer will be added. The deleted trailer will be @@ -199,12 +199,12 @@ the closest one (with the same ) to the place where the new one will be added. + With `doNothing`, nothing will be done; that is no new trailer will be -added if there is already one with the same in the message. +added if there is already one with the same in the input. trailer.ifmissing:: This option makes it possible to choose what action will be performed when there is not yet any trailer with the same - in the message. + in the input. + The valid values for this option are: `add` (this is the default) and `doNothing`. @@ -276,37 +276,37 @@ EXAMPLES -------- * Configure a 'sign' trailer with a 'Signed-off-by' key, and then - add two of these trailers to a message: + add two of these trailers to a commit message file: + ------------ $ git config trailer.sign.key "Signed-off-by" $ cat msg.txt subject -message +body text $ git interpret-trailers --trailer 'sign: Alice ' --trailer 'sign: Bob ' Signed-off-by: Bob ------------ -* Use the `--in-place` option to edit a message file in place: +* Use the `--in-place` option to edit a commit message file in place: + ------------ $ cat msg.txt subject -message +body text Signed-off-by: Bob $ git interpret-trailers --trailer 'Acked-by: Alice ' --in-place msg.txt $ cat msg.txt subject -message +body text Signed-off-by: Bob Acked-by: Alice @@ -329,7 +329,7 @@ $ git interpret-trailers --trailer 'Cc: Alice ' --trailer 'Re $ cat msg1.txt subject -message +body text $ git config trailer.sign.key "Signed-off-by: " $ git config trailer.sign.ifmissing add $ git config trailer.sign.ifexists doNothing @@ -337,19 +337,19 @@ $ git config trailer.sign.cmd 'echo "$(git config user.name) <$(git config user. $ git interpret-trailers --trailer sign $ cat msg2.txt subject -message +body text Signed-off-by: Alice $ git interpret-trailers --trailer sign ------------ @@ -377,14 +377,14 @@ test -n "$1" && git log --author="$1" --pretty="%an <%ae>" -1 || true $ cat msg.txt subject -message +body text $ git config trailer.help.key "Helped-by: " $ git config trailer.help.ifExists "addIfDifferentNeighbor" $ git config trailer.help.cmd "~/bin/glog-find-author" $ git interpret-trailers --trailer="help:Junio" --trailer="help:Couder" Helped-by: Christian Couder @@ -401,14 +401,14 @@ test -n "$1" && git log --grep "$1" --pretty=reference -1 || true $ cat msg.txt subject -message +body text $ git config trailer.ref.key "Reference-to: " $ git config trailer.ref.ifExists "replace" $ git config trailer.ref.cmd "~/bin/glog-grep" $ git interpret-trailers --trailer="ref:Add copyright notices." X-Patchwork-Id: 13280660 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9C24AEB64D9 for ; Thu, 15 Jun 2023 02:54:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S242572AbjFOCyF (ORCPT ); Wed, 14 Jun 2023 22:54:05 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39934 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S242521AbjFOCx5 (ORCPT ); Wed, 14 Jun 2023 22:53:57 -0400 Received: from mail-wr1-x42e.google.com (mail-wr1-x42e.google.com [IPv6:2a00:1450:4864:20::42e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DC94D26AD for ; Wed, 14 Jun 2023 19:53:56 -0700 (PDT) Received: by mail-wr1-x42e.google.com with SMTP id ffacd0b85a97d-30fc2b44281so3889544f8f.2 for ; Wed, 14 Jun 2023 19:53:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686797635; x=1689389635; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=T5D/54p+HpeCu+GmS68q0IoXxV4LWpBoO9Tq42MbRDU=; b=UgtXxZSBzZA8TGFT5V6txdeqZiol1HHuA8V0A5wXia5z64BZYQVfFYw5W4fcC4A+mH iSteFsGAeuNRU81ajFf3wcOd/GcKKlZ5wlf+Nk+WEnFnomtUXYejnHmb6l1cjf6ow510 t0QG5x7XNrD+A2b6eKEHPtXpECWZfPrjDgX3xLwnblINELHFj/t0MpIOm+KbRxeKkYRQ QZpMwaBRzhA2ivmFzEH5A+rz4mYMoASUn0MXLQ69Qp9jGWvRyK9MR1k23dXij57wa3XF QZXqyT6k4lIu0Qn0x67MQuEuU16Fy/z4HLQGXXufhO+VW9MQrIv+zM5mtB6H/31qvEA0 OXuw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686797635; x=1689389635; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=T5D/54p+HpeCu+GmS68q0IoXxV4LWpBoO9Tq42MbRDU=; b=L2ZZ7cJR+PU4tPzAGhIYdSxZv/DbpZ06RyIraKYmMxOSEhG0wRerYeJC0kGyvia/vp g3gVP0RGPTuUh+kz3Ren5jYLRn6U5cPVGhjCHgBekcUE67ehHO9LvhzNtmOX01oyDuuf FssL0da6zdsuOJYqlo88mPwrZl/kdk85uTem/aN1tD88/JgulS/RirNUgyDLMOFRzvpo YrpG5/V74VChXWkvHFnLyLtwOKChk5EE6VgRNZO0U9n6RCbeHNZBdTsKYFiAU8qqPvUi gYcdxCPPsNW9KiuLApQe5wkqJN4BPz/Z5+EtfYlkNxWlNH2aGnEYk0OD2GaxVJ6wBxTC 3f/w== X-Gm-Message-State: AC+VfDxWhVLtiZMdWcRlG4AJvlXA7dmfbmEshjVkbbzfrcyepuI1ZZph IB9VnKbseuimPbTvEOPaIVO3WyKSMDg= X-Google-Smtp-Source: ACHHUZ7/R1bNSDuY8qq7mTJCAniu0gO+tNJWrry2TK/MwnuRC04ec1Q4cqViwZteAczs0AOB11bG5g== X-Received: by 2002:adf:dec5:0:b0:30f:bf71:501b with SMTP id i5-20020adfdec5000000b0030fbf71501bmr8129216wrn.61.1686797635112; Wed, 14 Jun 2023 19:53:55 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id i4-20020a5d5584000000b0030fc576633dsm8988789wrv.16.2023.06.14.19.53.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jun 2023 19:53:54 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Thu, 15 Jun 2023 02:53:46 +0000 Subject: [PATCH v4 5/9] doc: trailer: remove redundant phrasing Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , Linus Arver , Linus Arver Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Linus Arver From: Linus Arver The phrase "many rules" gets essentially repeated again with "many other rules", so remove this repetition. Signed-off-by: Linus Arver --- Documentation/git-interpret-trailers.txt | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 58a9c691492..7516593c470 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -72,9 +72,8 @@ inside or after the value. The value may be split over multiple lines with each subsequent line starting with at least one whitespace, like the "folding" in RFC 822. -Note that 'trailers' do not follow and are not intended to follow many -rules for RFC 822 headers. For example they do not follow -the encoding rules and probably many other rules. +Note that trailers do not follow (nor are they intended to follow) many of the +rules for RFC 822 headers. For example they do not follow the encoding rule. OPTIONS ------- From patchwork Thu Jun 15 02:53:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13280662 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6A939EB64DB for ; Thu, 15 Jun 2023 02:54:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S242714AbjFOCyJ (ORCPT ); Wed, 14 Jun 2023 22:54:09 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39946 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S242585AbjFOCx7 (ORCPT ); Wed, 14 Jun 2023 22:53:59 -0400 Received: from mail-wm1-x334.google.com (mail-wm1-x334.google.com [IPv6:2a00:1450:4864:20::334]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A9D9726A4 for ; Wed, 14 Jun 2023 19:53:57 -0700 (PDT) Received: by mail-wm1-x334.google.com with SMTP id 5b1f17b1804b1-3f7fcdc7f7fso1997745e9.0 for ; Wed, 14 Jun 2023 19:53:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686797636; x=1689389636; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=zhzNVszT+Vo/FZZYrTjw3PrSJR7DAlK0zG3KVKzKwJY=; b=PqkyIBeUNUDoC3G8LIo0WzsomxAVgQ3SvevXwsybqIcwxdheeBb/JJqmjrDJur9ncc UIEeG5aReDb9pmPAVL344FFJokbHjvrgtkwzq+EaqGq63dVxex2VzwWnAdQRsQtCM+LU TghzUB+YU5QrSVCLuLLH5lAAZXqZLdmuk3VFUaXRdl4Rvt2hU3CO2othyenIqRsM71rc zwq/WFMLejvYFsZc1up/FtOq0bwitUAwlGe2ZqlTkB4CMIw0epd9W9EGXZXA2fhHqMo3 qXEHJAQQNTIOJ3pSa9BJoY2CAPbPT7r5LxbIZ+uJ4Flcl1Y7UjyqFn9rXbrBbfQkWiRc 4DDw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686797636; x=1689389636; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=zhzNVszT+Vo/FZZYrTjw3PrSJR7DAlK0zG3KVKzKwJY=; b=MiVwehxPPRwhJZ5yrxhr/L5g1nukoxf0DdJrtQNQfVuG1JRpPtWgf49ElB13fN4p/O IuO9I5Mp/LnK7m8aKHlvxIlsjJqSLnjKKj4X51AmtGZuGNuRPpF3/oO6df0yW5z6cM6v kdhQf/mx5rgOlYi1x4lu82/hCXEaPOD6tvqlyruhomx47p6e7ZZ0466v0JuwOdpXuUJp D1LnZkD9HSSn262LrRieC76JYebcybnzYgLH4FPcWO4spRHfNi2lesxvekWOz2ygjYyB NdKPIT8fBOhu1+iFGkCvNkxY23O1DsnRfC24BGzZDrs/b+5Ix/QRtmXPlq+UVyOI074P SEZQ== X-Gm-Message-State: AC+VfDxk5/Ppk9dW58544aJ26RMihf0gxQGRAPerLzdeDATjiu6Dvzs0 Ppl7xpcsQhWD0/S2RtcZZu76sLGwl/k= X-Google-Smtp-Source: ACHHUZ6OWUaRbrDsD4RH9Y/cliJUm2W+o8VS3TcbJNiLe4lBr0SlCIH4SS7Kt+O/n4WGU1JWzcJWpg== X-Received: by 2002:adf:ec43:0:b0:311:ab6:1a8e with SMTP id w3-20020adfec43000000b003110ab61a8emr2630079wrn.9.1686797635898; Wed, 14 Jun 2023 19:53:55 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id e5-20020adff345000000b0030630120e56sm19814127wrp.57.2023.06.14.19.53.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jun 2023 19:53:55 -0700 (PDT) Message-Id: <7a96d0705b991bdfc585041877e0eee3811461f2.1686797630.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 15 Jun 2023 02:53:47 +0000 Subject: [PATCH v4 6/9] doc: trailer: use angle brackets for and Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , Linus Arver , Linus Arver Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Linus Arver From: Linus Arver We already use angle brackets elsewhere, so this makes things more consistent. Signed-off-by: Linus Arver --- Documentation/git-interpret-trailers.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 7516593c470..97dc1c8c95d 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -66,9 +66,9 @@ non-whitespace lines before a line that starts with '---' (followed by a space or the end of the line). When reading trailers, there can be no whitespace before or inside the -token, but any number of regular space and tab characters are allowed -between the token and the separator. There can be whitespaces before, -inside or after the value. The value may be split over multiple lines +, but any number of regular space and tab characters are allowed +between the and the separator. There can be whitespaces before, +inside or after the . The may be split over multiple lines with each subsequent line starting with at least one whitespace, like the "folding" in RFC 822. @@ -241,7 +241,7 @@ trailer..command:: This option behaves in the same way as 'trailer..cmd', except that it doesn't pass anything as argument to the specified command. Instead the first occurrence of substring $ARG is replaced by the - value that would be passed as argument. + that would be passed as argument. + The 'trailer..command' option has been deprecated in favor of 'trailer..cmd' due to the fact that $ARG in the user's command is From patchwork Thu Jun 15 02:53:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13280663 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8F2C9EB64D8 for ; Thu, 15 Jun 2023 02:54:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S242726AbjFOCyL (ORCPT ); Wed, 14 Jun 2023 22:54:11 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40012 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230373AbjFOCyD (ORCPT ); Wed, 14 Jun 2023 22:54:03 -0400 Received: from mail-lf1-x12b.google.com (mail-lf1-x12b.google.com [IPv6:2a00:1450:4864:20::12b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E522226B0 for ; Wed, 14 Jun 2023 19:53:58 -0700 (PDT) Received: by mail-lf1-x12b.google.com with SMTP id 2adb3069b0e04-4f7b641f54cso1092096e87.2 for ; Wed, 14 Jun 2023 19:53:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686797637; x=1689389637; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=saNHXBs3nv1StVWETe8Xt7DS62AovQzrX2XVG5hfY4o=; b=MI0ZleYj6w8Tx5EA/9/3DW/Wd7QRrXtvSjPQyOLUS2kvRhDdVO6rfUopgfkUpRuKSe 57ZgndMbL4ecdG5u5PxGWciZx1RWDpHTtD3ECrcNnQmQTyjgmu9wiodsrwjtVhKIhOi2 2Mhev9EcDUn+SkYKo67BtNkQNXGCm4bvOxqJO6GGVI8flqlKMcqjDSQHyZeA5dm5XYyu RFW0ew12/Lojj8/q5+fqx+iUZVZ7hIoLHoWbjZyAcEAsLgIaog7g3v5cugzuc8faPeMA R8lQl/XnoR1kI71Lj3BnsmWPD/vMz/xhu1flPsccSkFd0t7oOqRYdSmnwb3dQaq+iNHD kgrA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686797637; x=1689389637; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=saNHXBs3nv1StVWETe8Xt7DS62AovQzrX2XVG5hfY4o=; b=Kn1lUu9wa3gMoSX3pr7lKJ3NZfxv44zgDKJcy0cVnRq1zHbt5s0H/60Nfqt3Vf/+vr Qk91SNWLcCW76eoWrKgH8NDaiW8A1VI50ek303mr96uSXF8jyqhTbh0vgHzKxHXye4u8 E1VYfbg4dRSnoAAIPciiUbZ0mOfhPUjCPyyCIFoT1UDR6SBFf1N2dnZ1amOnmQeZuvG5 K4nengiquKzguEzG6DGqA2QcfJf8fPfdhFENzOPI0chmV4Xu5eA3pK7XlaAMbqRdQYOs xE4GW4GoB9lkCzUGEcjT8G1DVw2sCATn7lRE2BEi7DE5C17vdcc6SERW68Vkn9lwtyjM G1XA== X-Gm-Message-State: AC+VfDw8FUNa2GpEBbwZq9lJAN2ubWAzQbBXGAn7CttTmKRqpbvknCPa SZ1qJBuG8x8JZzpHm10d+qPPJrI+nk4= X-Google-Smtp-Source: ACHHUZ5WtSWpisWfNJwvCdNoiLVjkLaz2oxu+nePWz3NYCnaijAVx2PCnpjaKzvrEliy0caCGHLh5A== X-Received: by 2002:a19:430e:0:b0:4f6:5068:3c0f with SMTP id q14-20020a19430e000000b004f650683c0fmr8486234lfa.58.1686797636725; Wed, 14 Jun 2023 19:53:56 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id s14-20020adfeb0e000000b0030ae53550f5sm19697801wrn.51.2023.06.14.19.53.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jun 2023 19:53:56 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Thu, 15 Jun 2023 02:53:48 +0000 Subject: [PATCH v4 7/9] doc: trailer..command: emphasize deprecation Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , Linus Arver , Linus Arver Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Linus Arver From: Linus Arver This puts the deprecation notice up front, instead of leaving it to the next paragraph. Signed-off-by: Linus Arver --- Documentation/git-interpret-trailers.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 97dc1c8c95d..6016af5c203 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -238,13 +238,13 @@ trailer..ifmissing:: that option for trailers with the specified . trailer..command:: + Deprecated in favor of 'trailer..cmd'. This option behaves in the same way as 'trailer..cmd', except that it doesn't pass anything as argument to the specified command. Instead the first occurrence of substring $ARG is replaced by the that would be passed as argument. + -The 'trailer..command' option has been deprecated in favor of -'trailer..cmd' due to the fact that $ARG in the user's command is +Note that $ARG in the user's command is only replaced once and that the original way of replacing $ARG is not safe. + When both 'trailer..cmd' and 'trailer..command' are given From patchwork Thu Jun 15 02:53:49 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13280664 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id BB8FFEB64D9 for ; Thu, 15 Jun 2023 02:54:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238043AbjFOCyM (ORCPT ); Wed, 14 Jun 2023 22:54:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40014 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235627AbjFOCyD (ORCPT ); Wed, 14 Jun 2023 22:54:03 -0400 Received: from mail-wm1-x329.google.com (mail-wm1-x329.google.com [IPv6:2a00:1450:4864:20::329]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 102E926B1 for ; Wed, 14 Jun 2023 19:53:59 -0700 (PDT) Received: by mail-wm1-x329.google.com with SMTP id 5b1f17b1804b1-3f8d2bfed53so2040925e9.1 for ; Wed, 14 Jun 2023 19:53:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686797637; x=1689389637; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=W1wHIMc14oKw4VoARADU2G/8t1T1JXAvLDNQoCO54L0=; b=IRX8UGzhrBDmuSb4WSxS+VNYe96+21zn0VWviUxYDxCPpvrQ5gcOk+9BysmeDHatRY LgyUNKdgKPyp2/0H+dLPpr9y40r+q0jUyWvOCY4I/2nSV3+3QEGJUTo0iASt6DpKDi8y 98XAmhxfvR9MaWwgQQ+oB+zsqmnRhzK9wScyPNrnecg/INK7GujdKwvfMZaFQo5k6+vd q0ETK1ZiJfKD9n/jpHz9l96VxmQQ1sGfhgUB50xzxwni+VLzOmP5TYPJzStceGdT7crD 9hsPewDFBOCw/XdHHgbsAQMo2PqwAPvt7Vq3I3XgLVO2HCtoegHrLRZSL/0gOKVODtT9 FFjA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686797637; x=1689389637; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=W1wHIMc14oKw4VoARADU2G/8t1T1JXAvLDNQoCO54L0=; b=MA3bXodqPe1kMm95EpdfkJzMY7Svc5v4513w3EgoT2jxpLM1ZuLU1riyB7azJmwv4R 3ioqN0UzSSAiezy3rynlELkjZrz6sdTDgeL67nX8WMSv4Imw3FbqxifviMaG5RziTPWq x4jIWBaUtzWBwKU/K1z3MOxNcJ9yL5sAMjJXaRJAscRVQEgiMKnq0arVWYkGgWH6Wj9Y Do+ArD+YlP2BWeFqGSt0Kpev2I7cqhZGOY0MfraxWwa91UEe/y99gK6U75+bVrE8fOAn uvO6xlL9VqzY4KiERm6eYWYcTYpiPVDaWdbg7jJCjj965L+eqtlRJ1jZ90T7oFskzMF1 anKQ== X-Gm-Message-State: AC+VfDwZrzuxzVEGUPjEfgqr4k8LVnbYyX/1h9pvXkowZA9nGPzIZ1mB KAG3BO48MajF/p3pUn7bdgHKXzYMBDs= X-Google-Smtp-Source: ACHHUZ4VoJmda0RWXlpZjoZO8vuHPPT2FeJmhRQYHQDuylu5myo+cQ0/ocIdIJcKkExFJcv2lqY0dA== X-Received: by 2002:a7b:ce09:0:b0:3f7:9b05:928e with SMTP id m9-20020a7bce09000000b003f79b05928emr2882735wmc.0.1686797637301; Wed, 14 Jun 2023 19:53:57 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 10-20020a05600c22ca00b003f427687ba7sm18906393wmg.41.2023.06.14.19.53.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jun 2023 19:53:57 -0700 (PDT) Message-Id: <604265c54dff9b2f16b8bf3b1964cae6280b756c.1686797630.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 15 Jun 2023 02:53:49 +0000 Subject: [PATCH v4 8/9] doc: trailer: mention 'key' in DESCRIPTION Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , Linus Arver , Linus Arver Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Linus Arver From: Linus Arver The 'key' option is used frequently in the examples at the bottom but there is no mention of it in the description. Signed-off-by: Linus Arver --- Documentation/git-interpret-trailers.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 6016af5c203..7e77cbb1cad 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -49,7 +49,10 @@ token: value ------------------------------------------------ This means that the trimmed and will be separated by -`': '` (one colon followed by one space). +`': '` (one colon followed by one space). For convenience, the can be a +shortened string key (e.g., "sign") instead of the full string which should +appear before the separator on the output (e.g., "Signed-off-by"). This can be +configured using the 'trailer..key' configuration variable. By default the new trailer will appear at the end of all the existing trailers. If there is no existing trailer, the new trailer will appear From patchwork Thu Jun 15 02:53:50 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13280665 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A3B83EB64D8 for ; Thu, 15 Jun 2023 02:54:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S240986AbjFOCyU (ORCPT ); Wed, 14 Jun 2023 22:54:20 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40026 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S242629AbjFOCyD (ORCPT ); Wed, 14 Jun 2023 22:54:03 -0400 Received: from mail-wr1-x42b.google.com (mail-wr1-x42b.google.com [IPv6:2a00:1450:4864:20::42b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AAEA426B7 for ; Wed, 14 Jun 2023 19:53:59 -0700 (PDT) Received: by mail-wr1-x42b.google.com with SMTP id ffacd0b85a97d-30fb7be435dso3654510f8f.1 for ; Wed, 14 Jun 2023 19:53:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686797638; x=1689389638; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=HV9gWd+BdhnDBHe1pDK/e53XygDoCp4vblwLD4ouDAI=; b=QDL/erMk+FKD4J2BLDQQJ/fzP1MVwbehM8YhPvi44SRKmgw+tXgt8gRHte8bnhkB3C 6TG9Mq11COf3M6DrX5BpmZJBpRLVgEPlMLVMTP6EZ6VSpDz++gYmsTi9HlFJB6LTPaIz pCnPlNtukZnNsjK2Ep2oWYXnN7wFDgWsxhEWEEPlZUCYdwTBpbAIl4mTMIFzacaXCI1o l3JzV1MFfFm6dxhyNep1/ovL1KiZkb49L4jKdYQ/+MqQImwfGHwZzKvgNGU1ZmpeiJDp m5U+c++AQI5ekUpO+5bojSN+bFixlglFD48t8LXcfY51MkWsipVZ3SnT127Qwjum26jH DwWg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686797638; x=1689389638; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=HV9gWd+BdhnDBHe1pDK/e53XygDoCp4vblwLD4ouDAI=; b=XLBl2CNzSa5fC+gJZm+89iyV8T3vFJ/wrdvtpCnyweLsE/HFxbFd0hCji6nm42vZL3 0q+/+a6qTChJJKXO+//EDhCnR9Vvu4Ygtj69Jtw8rRFoE8dWmrs/eGNGwWojFRjaM2h4 dQMXjNTBoNVCgzys8yZF9ujCPJ9L30H3uGauVwPgyY2FTHl++7UXmRhyhFNmAEgNTvTQ sUOxbMi9mbQE1Nyqrw0NooRwuhm0F1MzxrtPM39M6Jbgvm/NYpQDNcsvoG3kUO7EiWCk X9sR50cASNVWEHb6WFmfQsNUXJjHFju9zfxCMqk+fV8AyVzhc7o0dDc3J9r+Xyx6kx0c MnvQ== X-Gm-Message-State: AC+VfDxDrUbyL6AwTx7dx9NbBvzyL8Ltl1q0afT/PteMf8e0y9WgzpzA ik9aaGJ2MMa4CtV/kji1hTAPhy3lnvo= X-Google-Smtp-Source: ACHHUZ6n0T4bwo64KO8410q/ZO1c1c77uAGfrC8ES4nBzYizERQ1/y8LpnipmP2EJe3WruElPEJGaA== X-Received: by 2002:adf:eac6:0:b0:306:475d:92ff with SMTP id o6-20020adfeac6000000b00306475d92ffmr9403999wrn.3.1686797637959; Wed, 14 Jun 2023 19:53:57 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id a8-20020a5d5088000000b0030f9c3219aasm17468629wrt.47.2023.06.14.19.53.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jun 2023 19:53:57 -0700 (PDT) Message-Id: <1a3755eacbe13fda2896659e115ff0692fe29cf6.1686797630.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 15 Jun 2023 02:53:50 +0000 Subject: [PATCH v4 9/9] doc: trailer: add more examples in DESCRIPTION Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , Linus Arver , Linus Arver Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Linus Arver From: Linus Arver Be more up-front about what trailers are in practice with examples, to give the reader a visual cue while they go on to read the rest of the description. Also add an example for multiline values. Signed-off-by: Linus Arver --- Documentation/git-interpret-trailers.txt | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 7e77cbb1cad..55d89614661 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -16,7 +16,18 @@ DESCRIPTION ----------- Add or parse 'trailer' lines that look similar to RFC 822 e-mail headers, at the end of the otherwise free-form part of a commit -message. +message. For example, in the following commit message + +------------------------------------------------ +subject + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. + +Signed-off-by: Alice +Signed-off-by: Bob +------------------------------------------------ + +the last two lines starting with "Signed-off-by" are trailers. This command reads commit messages from either the arguments or the standard input if no is specified. @@ -73,7 +84,12 @@ When reading trailers, there can be no whitespace before or inside the between the and the separator. There can be whitespaces before, inside or after the . The may be split over multiple lines with each subsequent line starting with at least one whitespace, like -the "folding" in RFC 822. +the "folding" in RFC 822. Example: + +------------------------------------------------ +token: This is a very long value, with spaces and + newlines in it. +------------------------------------------------ Note that trailers do not follow (nor are they intended to follow) many of the rules for RFC 822 headers. For example they do not follow the encoding rule.