From patchwork Tue Jun 6 02:08:16 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13268160 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 471BCC7EE24 for ; Tue, 6 Jun 2023 02:08:31 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231811AbjFFCIa (ORCPT ); Mon, 5 Jun 2023 22:08:30 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45984 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229681AbjFFCI2 (ORCPT ); Mon, 5 Jun 2023 22:08:28 -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 4A491114 for ; Mon, 5 Jun 2023 19:08:27 -0700 (PDT) Received: by mail-wm1-x334.google.com with SMTP id 5b1f17b1804b1-3f6e1394060so48456025e9.3 for ; Mon, 05 Jun 2023 19:08:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686017305; x=1688609305; 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=l7FeDsGrh+e0esOwwU4ocBcqnziX/jj/Tx2FlMwBZfobLHXDMv9B+D03e5dcq/l9GL 7yBHlSCxAkrYRppo54vj5Ij+bcsLmB0+vFxVx01zBuqRqQviG/EEdLATtuJiRcFQb2ez JxmoW9JVO8AB1qIZI8v7VgzuqNJts9qZyAMuDYIstsimV7DqGV6Ir3IM/NpQFkxul+I6 8PR/Wb4eoAZzZ3ksPkwtbn5H20s3KG7TAN7f8ylmIY/mtfT5osc7iILkUyQFYZmV7dVD 0du4GO2ZHYmcVelci063EOmOIwMGMV5QBPkU2Iav6g/f6544eYh79aQSZNsn9gRoaFJQ R42Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686017305; x=1688609305; 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=BN9SNkLMVgPxXxPm3U7/Dx8J4OWDjNFbZVDPq4w1dPl9lpVszB7JGEALLldNvxyRHU Th0P2uD9I+/RoA322dtAr12VHTBMrJ2Ras8NRhawtT8n5UKMAlUe0yTm4feiILMQ2CHj vwkU0URKHBHDYXo6srtCe9PJLTQ9zh1CxLY+aVUZ/LGsG9JWgya6r8ph8cHzfUK8l8+7 cL6I5NRfgIu5g1apaYRUqKg4Pjdq0UO9epEeY9/ZQkgP6G9Zf6KEoXGJGQyP5dD1Lk9E Yb/gzNJryjDjuaQSKtUmkFWeQjLgegaxCGA+W7Lnu4eBYk68C2llx+tuP1CVrNjTSo1e s0Fw== X-Gm-Message-State: AC+VfDxzjwUdfUnSfomBontvOn4hPCI4iC1Qv/byIhdDwkxzAA2DUsn+ dpRmcigsKt50cOZt0kbj2SrKYJv7YPA= X-Google-Smtp-Source: ACHHUZ6SuHzCa2sO5GvEFSP3yv1UQUNrkex38R5dhNiCnD/nhnHiqMYSYC2bjb8RiFrGCVhUDOn3Hg== X-Received: by 2002:a05:600c:2288:b0:3f4:16bc:bd1b with SMTP id 8-20020a05600c228800b003f416bcbd1bmr593027wmf.39.1686017305627; Mon, 05 Jun 2023 19:08:25 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id f18-20020a1cc912000000b003f4e3ed98ffsm12331589wmb.35.2023.06.05.19.08.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Jun 2023 19:08:25 -0700 (PDT) Message-Id: <7d504700b91c175c952a16f0d82e642393ce7c84.1686017304.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 06 Jun 2023 02:08:16 +0000 Subject: [PATCH v3 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 Tue Jun 6 02:08:17 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13268162 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 11C1EC77B73 for ; Tue, 6 Jun 2023 02:08:35 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230089AbjFFCId (ORCPT ); Mon, 5 Jun 2023 22:08:33 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45992 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231268AbjFFCI3 (ORCPT ); Mon, 5 Jun 2023 22:08:29 -0400 Received: from mail-wm1-x32e.google.com (mail-wm1-x32e.google.com [IPv6:2a00:1450:4864:20::32e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 22B8B116 for ; Mon, 5 Jun 2023 19:08:28 -0700 (PDT) Received: by mail-wm1-x32e.google.com with SMTP id 5b1f17b1804b1-3f6e13940daso56220275e9.0 for ; Mon, 05 Jun 2023 19:08:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686017306; x=1688609306; 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=TqWY7eE/vXWtA6ROf10i2aKO11V+YlE0M6A2n5K4vpYTkbWR8fo5KMZq8qiQYMF2qN 1rwBeN+22JAWOpRhZkQVQNGy+Hrj1Cg8OXHVPOzRFJ+vKgfFudqo8Dt04DHi4rNukqye nIbAzI8vHJRRvEQAaFQ95HJOBknOAxpJqqgbCy0eOBUm6DFyoTspbV6Sdm2gi9xcC7H0 JscNQ49+XkIWuM/7ptAq/qSOYKiDDL4F58V1Gsbvlk8YcMFoCsHnhdPiiZ73pG3gzUQO /xxtz6zyiTK1TEagYPp0fG6sz0lBxPeJuMjRrtRf9k3vZXGHzgMLhLIUNsJWp/7mopEF 73tg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686017306; x=1688609306; 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=D52BzLtAl9HU/g2BqzzSJ0Qo2exzYHuP/uFZu79pTR6xFpE1y3sGuET5vWHsWEaea+ A5aqnea6mXPEJjPm2k3WneQN7FOH0VrCGJZE4JiN4gHACYZZduoUfhyRWvyF4xCPHxt5 /p+rxZYm0gaZYycVABHkaDVG80HuP9zq8uhqx2KlLQk5AhzrACAKvXvC6gPFNlLGy/Iu J7avFSNs9/ZEcteKUp/VbcxOMgCG6iRQmkJ9QuJ3gEt9Voun8UxgAZ1iVKxxufHrAuub XtQNXSpb/GevTegaozkiyJlxvpjauj0w3BE1i91+Nrx62vGPTJLNBdNOy1rGSPFr8z3T IBYA== X-Gm-Message-State: AC+VfDx6QrXqJl+11QjlfX9ucyirwxfjhDI3cU+IuSkPrULLvn5QxN+f NMkekYhEhehpPYuyvk7s+caBxnX8A5I= X-Google-Smtp-Source: ACHHUZ4g2Z79Vhft2Jk7ve1CL2NOoyQvIAaz70EZYnh5yMA4TTJwEX1hrsTXPXinL5Yx2dcD0tZT2g== X-Received: by 2002:a1c:750e:0:b0:3f7:a80a:c676 with SMTP id o14-20020a1c750e000000b003f7a80ac676mr796466wmc.39.1686017306323; Mon, 05 Jun 2023 19:08:26 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id t14-20020a1c770e000000b003f7cb42fa20sm4586897wmi.42.2023.06.05.19.08.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Jun 2023 19:08:26 -0700 (PDT) Message-Id: <65386432ca4a8a41acdb4f061a8ca6a8f02d289b.1686017304.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 06 Jun 2023 02:08:17 +0000 Subject: [PATCH v3 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 Tue Jun 6 02:08:18 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13268163 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 C6076C77B73 for ; Tue, 6 Jun 2023 02:08:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233194AbjFFCIg (ORCPT ); Mon, 5 Jun 2023 22:08:36 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46008 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231983AbjFFCIa (ORCPT ); Mon, 5 Jun 2023 22:08:30 -0400 Received: from mail-wm1-x32f.google.com (mail-wm1-x32f.google.com [IPv6:2a00:1450:4864:20::32f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 029F8114 for ; Mon, 5 Jun 2023 19:08:29 -0700 (PDT) Received: by mail-wm1-x32f.google.com with SMTP id 5b1f17b1804b1-3f736e0c9b1so24175755e9.3 for ; Mon, 05 Jun 2023 19:08:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686017307; x=1688609307; 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=YZW35HIxv10pZ96o/zdDJ1Hk3Aud6H5+AqOJW53iUPo=; b=XllSTker4bdOdrLbQWARvC1Y+eH7fdx9jzG9kPr1sSK3qSGmd83EaiDsqh0QEyxGeX JCy6BU8WgD7ze8uBzRgaPxUD8LmCibrCTV8Y4LdKbgpgMrhg1Vlc/aT0Tb2AAUz09+su rSmPI43Hj9QSSudhgyCqG1I/irPfWpM5+uRczjVhCK2Gv366kYmpOKqgNBFx/9txV8rt GfxvfNncV714/ROhn9/XqiacvNl1GZfAU+7FUJUC8lm4z4N1UTI133BVy5r65EvteAz3 i/0ka2DmaCeeGHmmXR7r4jdkExqsk6GbbLZ+lUP6F2BuV4zbhNjlbJbPTsPDZL7idAdg jyBA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686017307; x=1688609307; 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=YZW35HIxv10pZ96o/zdDJ1Hk3Aud6H5+AqOJW53iUPo=; b=MpOEaAvmefIqDXOpKc/3gMQSjzPvHVBOZuP0j0189rQ3rikO9Fmz8PAyyLOrvnpDGF 9ekcqIVRqgCzr0PajePwhlksTCCbr6q4J+ZjbYVTrSHmBerTjvQkxmh9F2yYPvCVdf43 KW5koGoHoW9qUkN0m2V1UR/ZrzfpUqrg15DLVq09eIA3C4y8ejx4a3IJVIQSZDbv2BuI nhS6ZxNVuHkZh+lrHgVQZLuTRGj3E3PQ+qQrGy1ZxHMLCQWYMvXktB9ipDPaLbkYPOD4 /toT6+iTHTwSU5PsUUQrJLCERavl3d+Ci6U51rZGJhF96ki/mj+90AxeBfCovE/O+xsU nJXg== X-Gm-Message-State: AC+VfDy3rRbpo5elLwSdu/0QcFv2RMQ5ag4XdRq/bkA5IvEeIYsFtd/Y vC063ZwhxyPPFJaaxY/Fq12cPrBbz04= X-Google-Smtp-Source: ACHHUZ51NtrOcEaOgPRtH9jli+2r1EOATUkKUzJe26ZTBqbDbkvFxjlEG8NiGSvAHSoYLGjdPfDCUA== X-Received: by 2002:a05:600c:3783:b0:3f5:fb98:729e with SMTP id o3-20020a05600c378300b003f5fb98729emr721299wmr.22.1686017307056; Mon, 05 Jun 2023 19:08:27 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p12-20020a5d458c000000b00307acec258esm11177674wrq.3.2023.06.05.19.08.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Jun 2023 19:08:26 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 06 Jun 2023 02:08:18 +0000 Subject: [PATCH v3 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 | 35 +++++++++++++----------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index da8fec7d5fe..ffde97a6c3d 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -18,17 +18,22 @@ 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 ignored, 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 +41,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 +52,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 Tue Jun 6 02:08:19 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13268164 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 A3093C7EE24 for ; Tue, 6 Jun 2023 02:08:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233704AbjFFCIi (ORCPT ); Mon, 5 Jun 2023 22:08:38 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46012 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232364AbjFFCIb (ORCPT ); Mon, 5 Jun 2023 22:08:31 -0400 Received: from mail-wm1-x32f.google.com (mail-wm1-x32f.google.com [IPv6:2a00:1450:4864:20::32f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6ABD811A for ; Mon, 5 Jun 2023 19:08:29 -0700 (PDT) Received: by mail-wm1-x32f.google.com with SMTP id 5b1f17b1804b1-3f623adec61so56904165e9.0 for ; Mon, 05 Jun 2023 19:08:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686017307; x=1688609307; 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=vsp3S46+y10MzDMDNcm8gZvewP5Rzxp4yVLzLAVHzgg=; b=UKt8UQLNgI9tpkr4snpONAp3QfNoz0LBspHB/8pjfpkWazEgJkux98KbUXNG89aCO+ +90XkVxUmvNf7a1nNGAYrG5ufmIyAF4p8n3zt4NlvQQ5nRiWV9ESBsVMixJdkGuta7u8 POy7G/ifmUtoXhxXVV52ykl6TxRzRZRcgATP6u+WYyGbAmUyQm9WBHEv/osNklfT8usB yQn87abq95BLJjEq226Tljj+7+Ed9iU3FSGwsRt3MtQth5bXtAY9Ucd8V8hk1IfdVww1 s9hGqsonpNbVpQKKWTkFdW6nDjgf+GrC2r8wIq3BG6EQIk+I38zaKgALSPyhgJ6ZHXVc 3SiQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686017307; x=1688609307; 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=vsp3S46+y10MzDMDNcm8gZvewP5Rzxp4yVLzLAVHzgg=; b=fRwJ6bV4Go0XlSNcindZaaPfIJA9wcDGfv3KVDJYN1y+q0zbXUGJzdp/FewgX4vlcz TtwL51knuN0UkoKhXj/cUn6YXNkjcniLf/I5TE4IsbgAuiPMUEXoDZuJVfPMyKz3Wc7L W1bS8e4ZxtGS1jyU452xYFgMJsyrq8SxCAKHODxHFDNT0BuWefMKZowsEWRDLpMyyNsM BNfmBLTu5P7fEBUEu87RFpf47RA9gVM2WIWO/RJW+ny6+qII4kGc0mWDHPvCBwAWAdiA itBUjvra0eaZQFtLGKuYfOfjxbwMMWt4xrh/aZZnULLMpYSXHyIRcYblzCmphVPNPPIo 3SVw== X-Gm-Message-State: AC+VfDya/2jOpJQPp4Du0Buq56qIOt2DlweEPlusggcVnrfMaZ6IU8Rj bgwI2nwi6SjRquIdXoXCMmecLa3D5pU= X-Google-Smtp-Source: ACHHUZ4u11M99V7t4tKuZlUS/rQ6EwYLIbg9i8e/xaXh5lLGVuwUQe/m89Q4CPEjmXqj/cgjD4wdaA== X-Received: by 2002:a1c:7203:0:b0:3f7:371a:ec8f with SMTP id n3-20020a1c7203000000b003f7371aec8fmr665930wmc.15.1686017307541; Mon, 05 Jun 2023 19:08:27 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id q25-20020a7bce99000000b003f182a10106sm12373997wmj.8.2023.06.05.19.08.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Jun 2023 19:08:27 -0700 (PDT) Message-Id: <52f7d29f509070a17a32a6f1c888588cc87e6cb9.1686017304.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 06 Jun 2023 02:08:19 +0000 Subject: [PATCH v3 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 ffde97a6c3d..011ed0c3590 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -82,12 +82,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 :: @@ -101,7 +101,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`, @@ -110,7 +110,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` @@ -177,7 +177,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`. @@ -187,10 +187,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 @@ -198,12 +198,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`. @@ -275,37 +275,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 +Lorem ipsum dolor sit amet, consectetur adipiscing elit. $ 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 +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Signed-off-by: Bob $ git interpret-trailers --trailer 'Acked-by: Alice ' --in-place msg.txt $ cat msg.txt subject -message +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Signed-off-by: Bob Acked-by: Alice @@ -328,7 +328,7 @@ $ git interpret-trailers --trailer 'Cc: Alice ' --trailer 'Re $ cat msg1.txt subject -message +Lorem ipsum dolor sit amet, consectetur adipiscing elit. $ git config trailer.sign.key "Signed-off-by: " $ git config trailer.sign.ifmissing add $ git config trailer.sign.ifexists doNothing @@ -336,19 +336,19 @@ $ git config trailer.sign.cmd 'echo "$(git config user.name) <$(git config user. $ git interpret-trailers --trailer sign $ cat msg2.txt subject -message +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Signed-off-by: Alice $ git interpret-trailers --trailer sign ------------ @@ -376,14 +376,14 @@ test -n "$1" && git log --author="$1" --pretty="%an <%ae>" -1 || true $ cat msg.txt subject -message +Lorem ipsum dolor sit amet, consectetur adipiscing elit. $ 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 @@ -400,14 +400,14 @@ test -n "$1" && git log --grep "$1" --pretty=reference -1 || true $ cat msg.txt subject -message +Lorem ipsum dolor sit amet, consectetur adipiscing elit. $ 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: 13268165 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 6B274C77B73 for ; Tue, 6 Jun 2023 02:08:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233081AbjFFCIj (ORCPT ); Mon, 5 Jun 2023 22:08:39 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45992 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231556AbjFFCIb (ORCPT ); Mon, 5 Jun 2023 22:08:31 -0400 Received: from mail-wr1-x430.google.com (mail-wr1-x430.google.com [IPv6:2a00:1450:4864:20::430]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1A45B116 for ; Mon, 5 Jun 2023 19:08:30 -0700 (PDT) Received: by mail-wr1-x430.google.com with SMTP id ffacd0b85a97d-30ae61354fbso4815691f8f.3 for ; Mon, 05 Jun 2023 19:08:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686017308; x=1688609308; 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=Ihtd9EwjiHg64SAxF3DrjNuDHzuY5uPrRcpeQk4UUSw=; b=Z3y7Dp+Qs9bUz7w0eerVjIORKRVLDL6U+OOKMnLxLwO4V1nRDloQMqa/3MZdGS3FJI JCCacSqfSX8kwkjs+9TcLHxkua820HvEwccs4HGl/EcBN2CZ5CHHhlKTzMA9RNZ/Jq5K biWT6nXLsDJMM1npN0PyxhPKKD/REfSIyRx4+/uh24qS7mYRyUVhcL4CFXrDm3fzmVS7 +cLtq0s7Bb1ua+EMVtd/ngo1yD9F4z+uIaLAiaDw+FJ8EjGAC4yY3dI5LbSope5iNE6L JYA91pMMaRpUIG1t2BvxTBvi7UHUuJTQKSZylXeGa6eStR8oY8q4vrQ4u8gWSHeeW8HD 4P/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686017308; x=1688609308; 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=Ihtd9EwjiHg64SAxF3DrjNuDHzuY5uPrRcpeQk4UUSw=; b=FSJWpPHXj1ghYdN8tsCrXZUcrr3DK6lKKWYkEFLmiPmrNBn8GwVPSxv3ePmMjppLqi F+Pjz3kxl7MKSSaPh8reF2pY0yFGhicfHccVSoVH8bB91/MhoqhOxmjA0FNLFXC5A/cc vUBGJ6q8zGWu7U3zfY/ocpFZ/MJxI4tblKPWx5BDimBA7gwPJ9ner5ufFs4AiEtI6BOL K8VLlHNB14WzrJdZcVoyy+mkSDMKN6yQd0HH9Wf4AvMiOTehdSuMXF2QlF5QZJLHvGZa /ADAxNVkU1gqhOP8p2fEfiZLQ8jnYHu+UWhoHCeupIHcvec7cfhTE2/I8SWKb2oHUhDE C1zA== X-Gm-Message-State: AC+VfDwD0vbTyI5cXiZFGQYXzng0wVVPshl2i3X5BRi3yc1kq4RNlbns c7HxopSHLXRsmokDr6+KS82GCOenN6U= X-Google-Smtp-Source: ACHHUZ4bLYxDglkLOFgwuh73qtEJ1gxf0pVnbtlCYr27akDsucOAbmMoOeUoSBsdlvIcrgBBAby4cw== X-Received: by 2002:a5d:5088:0:b0:30a:e4f0:40f7 with SMTP id a8-20020a5d5088000000b0030ae4f040f7mr520029wrt.2.1686017307955; Mon, 05 Jun 2023 19:08:27 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id u4-20020a7bc044000000b003f70a7b4537sm15901098wmc.36.2023.06.05.19.08.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Jun 2023 19:08:27 -0700 (PDT) Message-Id: <4a2a0e41e4a1ff0313ffc41d4c1683b5f7e14721.1686017304.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 06 Jun 2023 02:08:20 +0000 Subject: [PATCH v3 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 011ed0c3590..d1d3e50bde7 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -71,9 +71,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 Tue Jun 6 02:08:21 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13268166 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 20B13C77B73 for ; Tue, 6 Jun 2023 02:08:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232591AbjFFCIm (ORCPT ); Mon, 5 Jun 2023 22:08:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46028 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232646AbjFFCIb (ORCPT ); Mon, 5 Jun 2023 22:08:31 -0400 Received: from mail-wr1-x429.google.com (mail-wr1-x429.google.com [IPv6:2a00:1450:4864:20::429]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C936D11C for ; Mon, 5 Jun 2023 19:08:30 -0700 (PDT) Received: by mail-wr1-x429.google.com with SMTP id ffacd0b85a97d-30c55d2b9f3so4010772f8f.2 for ; Mon, 05 Jun 2023 19:08:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686017309; x=1688609309; 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=cAzdVs31j9ocwgc2w0Elu7l4swsEpKP736YN05aDSR8=; b=D32R4pAyP6ocjwgJJ1r5C+1LHU5Il3NVpDjjMplL5GMd5Z3OdrBAHj3QL2ZIRKLXPz dEzugOXm6JjbmUQ3k4LK7FU0myKhWV5+x2vAId7Pc3/WTrSnYzhr7XU6VCv85vQ32rGi NMgOOpmX6ynMAdngbmO/jk7a5mJV7yV+l65qLuKb4RiBTRWEiSnxYKI38mb7QLxkrEb1 MWbL2hXqNyz6ZO674ElonLK82v/H0lO6JSxo5cDEwUP9iBzG+8AgUnBM3ZmKF1nJXn5e xMh36NME/Lt1hyHIyAUH/URxtg0pSM9NDaDpOBD5BE3IFLUITbaRHCBtrCUJo+Av+gBE p+4w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686017309; x=1688609309; 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=cAzdVs31j9ocwgc2w0Elu7l4swsEpKP736YN05aDSR8=; b=FCCsQM1wltPkLtrvRrHejj88nTTOxlzCsdgi+84lrH0jeiIoR60FZR0jngeT2PlVEE de+RUBGzufUktVGDjGGPpJUKjG0Q3stRyrMCyzQ8YYo4qFeAqE57nEYkY55aBEcj52d2 b30FxQWVFEmzdEgMoSdI+fqhqfD28H83DfcrdUKVeLojQDz5D15BBFYS4+NGWbvQMszD 4jDj1H/Vt/H8wjiBCAUhlzGGCpVfGxWR3vuJ2EXE+xtt1azhWlSPdqzrfEBHfQGn9sqX 9/eYQAMHxePBuox2CTrgR2oggImM6p1cTOu9aZYbnyjA6uIPwmf3ys5uefOFXqauYJuG pRNg== X-Gm-Message-State: AC+VfDyTPgge9ejDasuXDzRVbBOSLc9PureZKGP/eWW8uyZRL/fr0sRb zfXfRTP4eYKpdR4lYVF6IV7W2ptqUgg= X-Google-Smtp-Source: ACHHUZ7NkMuFGCsPcNovARjist0RFSbWPy+2txOZflFUKo4GZOOnPTqm7hxqu+rPgZbA+kiRn6tC7w== X-Received: by 2002:adf:f54a:0:b0:309:31ac:6663 with SMTP id j10-20020adff54a000000b0030931ac6663mr442159wrp.16.1686017309016; Mon, 05 Jun 2023 19:08:29 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id o1-20020a5d6841000000b003079c402762sm11159692wrw.19.2023.06.05.19.08.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Jun 2023 19:08:28 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 06 Jun 2023 02:08:21 +0000 Subject: [PATCH v3 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 d1d3e50bde7..d69851dd367 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -65,9 +65,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. @@ -240,7 +240,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 Tue Jun 6 02:08:22 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13268167 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 55FB2C7EE24 for ; Tue, 6 Jun 2023 02:08:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229836AbjFFCIo (ORCPT ); Mon, 5 Jun 2023 22:08:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46034 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233003AbjFFCIc (ORCPT ); Mon, 5 Jun 2023 22:08:32 -0400 Received: from mail-wm1-x32a.google.com (mail-wm1-x32a.google.com [IPv6:2a00:1450:4864:20::32a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 796C311D for ; Mon, 5 Jun 2023 19:08:31 -0700 (PDT) Received: by mail-wm1-x32a.google.com with SMTP id 5b1f17b1804b1-3f6094cb2d2so56718915e9.2 for ; Mon, 05 Jun 2023 19:08:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686017309; x=1688609309; 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=OjggJblZVc+bqsLtSGFEd1RSSRopMikR44cTGZbcbgc=; b=c10bqXFfj/zVshsmoymnCjawA7ovABl5Mjo3vyknuw9U/kKlJTrXGo7P+V7blx/2Bl zUTwINONi30gtjs6sdbe1Wc9tWze7CbRKn0alAROIwsYiNhWeKjc7qRSu/+prboolB6H WlFqxQ2WNw5Z3MYZiWv2Ffz+YGLRmcpUDxQVVB+rDdWxfwQgMTcRKQ1la1x5SH0WrrjA mxM6wz2BAQ1BFbDjttvjkOURPSxNxtlEjdVDq3MEs+0h0+wIY8cg3ltMcFXyZtRz9Jsf Ksuoq5Ea+qWMlML8XI/TNKWBi95jJec7yUkiBGOHbwNPD5hneEB06cgxdg+amcq9rC+6 F2FA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686017309; x=1688609309; 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=OjggJblZVc+bqsLtSGFEd1RSSRopMikR44cTGZbcbgc=; b=FV3sRUn2OgEKiCjrY944HdyTM4JRLfUzldv2bW4u2E9oZ+iywBM5dpxriSGho4A0Qs 7oCAZOZt7VJccdPE6idhp94xLfQJEm8fMaw17MMeJjdjAuhm1OhJ3nOwUbsTYzCxZb8W zI3fr05yZJxZxYIcy5qZftMJsQhWWpeTt0sxCRhS25FH8cHXlCTOaB6b1Z6x1gFkNbjU CtCjbrHRevV3cyg1oXriFIp/n45nvdGaE7gJuORBd5zid8qov0ID/eBxif3hMZCJa5HA o0SKZtxQSDWHZW3qH0korjoSrVI9BPdW1zfodonuYXSwj4mcaSmk1wQRasJL0Jg3DsXv Q4KA== X-Gm-Message-State: AC+VfDwmebPHbOZuFUMvrBlVXoRxNKQHSP36CFfnfgu72JSssCKPzcDx 4BMHKVhP2ZQK1sqNWHqQywS1L5zzScA= X-Google-Smtp-Source: ACHHUZ4VYSuNt6q/ZRnFjbfL3cvEyIdSd7/TqNBgK8JLY9BhWrLSKW4FazgD1SzkkQGMSIaber+6SA== X-Received: by 2002:a05:600c:3783:b0:3f5:fb98:729e with SMTP id o3-20020a05600c378300b003f5fb98729emr721367wmr.22.1686017309726; Mon, 05 Jun 2023 19:08:29 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id n24-20020a7bc5d8000000b003f17848673fsm12418202wmk.27.2023.06.05.19.08.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Jun 2023 19:08:29 -0700 (PDT) Message-Id: <6aba774489a2a0f4f7a2c52a71cbe1f8d2b6a686.1686017304.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 06 Jun 2023 02:08:22 +0000 Subject: [PATCH v3 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 d69851dd367..b034784e1d8 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -237,13 +237,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 Tue Jun 6 02:08:23 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13268168 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 4A33CC7EE23 for ; Tue, 6 Jun 2023 02:08:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232459AbjFFCIp (ORCPT ); Mon, 5 Jun 2023 22:08:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46052 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233096AbjFFCId (ORCPT ); Mon, 5 Jun 2023 22:08:33 -0400 Received: from mail-wm1-x32b.google.com (mail-wm1-x32b.google.com [IPv6:2a00:1450:4864:20::32b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1B0FC120 for ; Mon, 5 Jun 2023 19:08:32 -0700 (PDT) Received: by mail-wm1-x32b.google.com with SMTP id 5b1f17b1804b1-3f73617a292so24874885e9.2 for ; Mon, 05 Jun 2023 19:08:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686017310; x=1688609310; 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=C3gQ8urtDAFj+gIyEesDdzctqp251ddngobfDOosdKc=; b=Nm502Jef/RVnei3cleeE3jUKWiwDpxFnIBkw6P5zFjaN+btvyiO75eZRvrpVhfcLQu KRJsbFaZQKO58S2jyjlOdl52zQyG4YnlRaJRdx84zCbH6KKDCXH0uY+1PBNAs6CM8aQC pyrmCqKVnXzrT+dot6Lfaoi3u/lwkvNRDJRZAnk9jZrfS6AIw1kV5vEEahRm71olLtgZ Rj8IAJDY5HUqLoVrg0WjrxAYV8RcdCRr8bYEsu11U/hIYKzP2O0pRlWVcX2rvHPjjKcH vTkn7blFrJRPVJewYxCWxBNxb1G5sh7avxawjQuzgCgxQ4DbIL6ZVNMWAhgHVoaweYgh WYPA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686017310; x=1688609310; 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=C3gQ8urtDAFj+gIyEesDdzctqp251ddngobfDOosdKc=; b=RaMj/ODup/M3a8XkEWbhSKxtCv8JjZVpoM3pdXksra1xW72FV3zfNLTjWJBto+0Sv5 iJd8RbVAnC2oI7OlrP+RdxPwrOeaOC9BsF6QG1q+fK4vQI/gATJdwoM4MXSeRQcxd1rE ukjh7BdSt9P2U/5k98Ge3cZYATyJRR06Xv0HJ9QgId1CkZ5GqcYv70H1vPr95wmfJwAj rrpM+B+vA70SVp75SRzKnF+peD3qkFXlJU/akNNOOK+ksg5JS87pNRhK362maekDFhBh Buq01m0qR1fi6VcdfwKP8aVelarOAXeu9dNBKovVVjNZ4P4WTW+ITGn7rbG37XtUsVdz +f1w== X-Gm-Message-State: AC+VfDz4NFxs9LSY4T5yOhE/EnWEabw+cjLw/ul3BunPJvjxwH9YJVSp rr3BXb/ryLLzcilQoPGG5waNmbFpiEM= X-Google-Smtp-Source: ACHHUZ6UimXPRGoyudjo1Ks7hOmuU2l23vclh83TS05T/J8QGIR5zr2FUXAVz9Kre4qUwfvasUaYAA== X-Received: by 2002:adf:f591:0:b0:30e:4935:f567 with SMTP id f17-20020adff591000000b0030e4935f567mr474612wro.56.1686017310349; Mon, 05 Jun 2023 19:08:30 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id f10-20020adff98a000000b003090cb7a9e6sm11051564wrr.31.2023.06.05.19.08.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Jun 2023 19:08:29 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 06 Jun 2023 02:08:23 +0000 Subject: [PATCH v3 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 | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index b034784e1d8..2e92640543c 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -48,7 +48,9 @@ token: value ------------------------------------------------ This means that the trimmed and will be separated by -`': '` (one colon followed by one space). +`': '` (one colon followed by one space). If the should have a different +string representation than itself, then the 'key' can be configured with +'trailer..key'. 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 Tue Jun 6 02:08:24 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13268169 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 C04CFC77B73 for ; Tue, 6 Jun 2023 02:08:48 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233753AbjFFCIr (ORCPT ); Mon, 5 Jun 2023 22:08:47 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45992 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233303AbjFFCIe (ORCPT ); Mon, 5 Jun 2023 22:08:34 -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 E94E312A for ; Mon, 5 Jun 2023 19:08:32 -0700 (PDT) Received: by mail-wm1-x331.google.com with SMTP id 5b1f17b1804b1-3f7368126a6so19941675e9.0 for ; Mon, 05 Jun 2023 19:08:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686017311; x=1688609311; 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=qF9ZICbcyWdKLQ2q5HFZV8YkdUD9NJai6d7eys1IsDU=; b=oa4qR0hzpK8088Pq/EkeVQvzUgu4dfUzsL80bQrlNBA9lMq5ZqpYTPA41OO8Ula7MD sMH6QGjCUJWc9KUscjUWn/RRCOvIY/brMFP8YbYemZ2R2sjXgCcVT9VVfB8IxKjFeYGw aa6Q3bVrWZw1QaLlxitfNEYnye59A4XQ/k5xt0JbBLbL1QkLbTVf7KzAgDel/XYq64+W 1gX3TwCAnppWAhf2qEgRK3RKe8KRoLR9vyevXPs8eDIThOfXJ8hPSTlQ+e/snJhP0hGl I5/mvBcElUUnAGrjQ5b5YHKdPpxqcbj0UQtip7TDjAQLz2CuUV5A++imgP8VOuJe5+0S h4pQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686017311; x=1688609311; 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=qF9ZICbcyWdKLQ2q5HFZV8YkdUD9NJai6d7eys1IsDU=; b=kM3a3SAHmSXCxLN+ufI/625msimixYIg97hF+UwJF1WFoE+1+WTlDqMx2aNhY+J8NW xpoKR7eNdOVXUHwWw1vnvMBRWSvq++tuOQk9yKWi62tqP9o8V+e3y2U56T1BmJnR/HqP 3ijw4XJuTbtyfm6/LRrK+F5JsDX949+oQR5ocz3x5HFGe09vTwmEU0oq///Z4Ux8QaZ1 NsJN9LLA6T8ldISnc9bo8U2xnNvkQ+NwRoI/R09euSagQSTYHZuArLSoGZvh5gHh5IAW 9A5yH1dKgOnS5QHXQbHPhBrTjQ+TNqefJNxWRm6f9sUE4gIsrH9pjQaYlkRXbsBfJKhU jMcw== X-Gm-Message-State: AC+VfDztF5Ldu/rfASiE4uKMRccaBy0R1B8w65NP8pwULzbLvuh4GlbH oO7eH82Qkx6rjClOTwJrI93Ek61BhoU= X-Google-Smtp-Source: ACHHUZ7jP+X7O4s9bdAmH9yZhTQO1q2GrACK56hIQBruHS99Q8fhSFUx0lbWP3HgwGWmnoCroP+SGQ== X-Received: by 2002:a5d:4488:0:b0:30e:3f54:f8c9 with SMTP id j8-20020a5d4488000000b0030e3f54f8c9mr492861wrq.10.1686017310991; Mon, 05 Jun 2023 19:08:30 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id f9-20020a5d5689000000b0030ae93bd196sm11194374wrv.21.2023.06.05.19.08.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Jun 2023 19:08:30 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 06 Jun 2023 02:08:24 +0000 Subject: [PATCH v3 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 2e92640543c..2e999320ec6 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. @@ -71,7 +82,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.