From patchwork Thu May 11 21:19:27 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13238461 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 B32CDC77B7F for ; Thu, 11 May 2023 21:19:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239324AbjEKVTm (ORCPT ); Thu, 11 May 2023 17:19:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59880 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238915AbjEKVTl (ORCPT ); Thu, 11 May 2023 17:19:41 -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 5EABD2D62 for ; Thu, 11 May 2023 14:19:39 -0700 (PDT) Received: by mail-wm1-x32a.google.com with SMTP id 5b1f17b1804b1-3f42c865535so36631195e9.1 for ; Thu, 11 May 2023 14:19:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683839977; x=1686431977; 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=oHRQknyIxF3+lTVfNovqlnPtcirZttRbNMIjXEH1Qss=; b=DONf56Up3uqsRz0jERs8btj1oK+O/ZMF2pSO3Ua0gYdoTGvnw1CaceIs7EbdzkBLxs er23U82MT3cJ4SbIUgEpH18moVIZ4YXN/FDyTO6Ibc0cvu2J4sqJzyXDk/kYcbQ7Zk3N /VxL5qU0ecNOisC49cJqYaMB7nE6izybEJEOBntxTR8zETXEFJ+iKDzYCpGnRZuMmE9r n4rh5pi9+hOxiOEd+KEIFH1C185IxvZl050K/NA/TwwQCZbRjMSyANeuhClsMGqQFElg O9HOrGO42FhVTTdWElFK6RRBpGGBOcmO5wa3v64Ux3e06jOh8VTZ5uCz7MHcrSpxCoEc /V6Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683839977; x=1686431977; 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=oHRQknyIxF3+lTVfNovqlnPtcirZttRbNMIjXEH1Qss=; b=Utc95NWq8y9/gi8owWdbY9LowTzcbg2cJctobLdsVYuLlH51eBLaisI6V39PneADJQ jfaHVOg1S9tGlbnOj08GCC7ESnEuHQpjB+VUHmDYNH938AW13rq2AzEgTaG+AWwBn5XU cHRKIMvXvjWupscrJVslHMGXdrWRCazawe/3x6zXlWjudCVVXtEQ54eSmkyh9EQrHdfa ZN1B2Efy4HzUi5VqZjZEtfvnnOVym2hLpDyXBqj9baKQ6gzP6yvqzv/uhlCrq6Gfzuyt RC6OllSe8hxwI/g/T1dVCGcCgJlu/OZlsQaC887cP8yppuTmMNi0gm4MCsBNdGjPHurj KxyA== X-Gm-Message-State: AC+VfDz43Waf8QslGSjhPX4l30V42JI97F6FBrVo1mpVOX0rZK8ZHKvl AhCNvUEXswa/JZ8cfJDgu1NwogCMIL8= X-Google-Smtp-Source: ACHHUZ5pPOR8t3BfynFmKsugXG/o6YD2u5xBKNAUVMySuUWPIPg5C3o9SmyO+jXhd82vvI2UC6EIqw== X-Received: by 2002:a1c:720c:0:b0:3f4:27ff:7d54 with SMTP id n12-20020a1c720c000000b003f427ff7d54mr9034883wmc.3.1683839977421; Thu, 11 May 2023 14:19:37 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id c3-20020a7bc843000000b003f31d44f0cbsm26876801wml.29.2023.05.11.14.19.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 14:19:37 -0700 (PDT) Message-Id: <65e6fbdec9248f24fbc0b40ce15c628f0167d901.1683839975.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 21:19:27 +0000 Subject: [PATCH v2 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 22ff3a603e0..1a1d6288b17 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 May 11 21:19:28 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13238463 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 C1C1FC7EE25 for ; Thu, 11 May 2023 21:19:46 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239359AbjEKVTp (ORCPT ); Thu, 11 May 2023 17:19:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59890 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239049AbjEKVTl (ORCPT ); Thu, 11 May 2023 17:19:41 -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 A26822D74 for ; Thu, 11 May 2023 14:19:39 -0700 (PDT) Received: by mail-wm1-x32b.google.com with SMTP id 5b1f17b1804b1-3f42c865535so36631225e9.1 for ; Thu, 11 May 2023 14:19:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683839978; x=1686431978; 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=+1HMil0jI6NcfQkK4FL1cabxBHvFRvgMOG9McKUDqLA=; b=JKiTL9Wpoor74KTy48fDpXeDaQaMs5S0bGA+QLnaIcShC13pgiFBtka2XXyB92RH9S 0+wVe/vt56BRf8GYg8N7gu16yQW1Rjif99pfbX6n5VOk+DsEC6bRVQXDBbe3TwJg7QXm 0r1OZnyVib3ojDG0D8esEaMIIc6BTV6na93gYvCClTkvnAuZG0uZWTkQeqQQE4QMLgLn LS2Kr8WfLyM/PQFcPnoHfU7S3q8hELseHvVsblDdfjoyfxjkGLk6JL7kFBJ7tkQmzY79 ocIkn+NMnBiu1sfDGhhHpTIhG9AvwA5J/7uxtTgn4SlD4FojEmRlcPgJfbG9rJLvahmb y+aA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683839978; x=1686431978; 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=+1HMil0jI6NcfQkK4FL1cabxBHvFRvgMOG9McKUDqLA=; b=hQTghWd/4uu1501QCTtSjo0PfySssk0AtLWAY0dvhf4Ua6aUG3hkOvO6c3OKc5VUO9 BUgrZHqMVGF5i95qEAXcY1ikEIXX4aZC57SckqaTxH3QJWaSmFfJoR/YMG/jfjToRkT4 FF5tgabq57klaK1o2auHoeIGyFfDMIt83FZzbedi5D8d9jKpev3tFWQI+ab8YI68xcsO d0I0AoLPNacJ0S5oubxLWdTtqxNvbhLjSf/huQZ1vJwjjJ9HUBnb9guaTtdgYsQ33V4A +L/MJ3VJdockRxP7RhPOaeVqwo/OyS6o+m8mW+b2WwgS/AbwVS4c+S8soiYXzhqvAyCr 4UQQ== X-Gm-Message-State: AC+VfDza7spfosOaaHaY6acCfXZpyTC8UYuKypKnnm8VPkFZ27yloxO3 l3CVYay2+NH8xS0yu7G6q8RAftYCzoA= X-Google-Smtp-Source: ACHHUZ7mNLaIsohl4UnxyNIyv3ljxOyBE8dCNTpxoOPhVSO0LKrMNjQPtNzjl53Y+378ydivtpDYrQ== X-Received: by 2002:a7b:cb58:0:b0:3f0:41b3:9256 with SMTP id v24-20020a7bcb58000000b003f041b39256mr14419149wmj.10.1683839977908; Thu, 11 May 2023 14:19:37 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id y5-20020a1c4b05000000b003f429d59e37sm9572722wma.34.2023.05.11.14.19.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 14:19:37 -0700 (PDT) Message-Id: <823534718313979920088729bb04b5d2433fa5c6.1683839975.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 21:19:28 +0000 Subject: [PATCH v2 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 1a1d6288b17..cd4d724a0b7 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 May 11 21:19:29 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13238464 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 577BEC77B7F for ; Thu, 11 May 2023 21:19:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239331AbjEKVTr (ORCPT ); Thu, 11 May 2023 17:19:47 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59910 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239311AbjEKVTm (ORCPT ); Thu, 11 May 2023 17:19:42 -0400 Received: from mail-wr1-x432.google.com (mail-wr1-x432.google.com [IPv6:2a00:1450:4864:20::432]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 47E342D56 for ; Thu, 11 May 2023 14:19:40 -0700 (PDT) Received: by mail-wr1-x432.google.com with SMTP id ffacd0b85a97d-3064099f9b6so5972235f8f.1 for ; Thu, 11 May 2023 14:19:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683839978; x=1686431978; 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=bX53ON7mzhZNh1r5Rt/vUAnbEJULUr8rQHsYs/xPHAk=; b=jqwNnUmcBagCoEwud68g61nEi2SQjbCLasllJOEk5VDyBoDDa5U+EIcy9/LTXuz4dm hkvrO8w7Gp5uar58zVrwTuBOdBm8cLd6bFnQwZ0Sv69/JK8QEcDRPzuECS/R1ejVyNZP 8cv8uFCzItM4mLVGJQyKi9UOpMu3i2LLgtfBGu/UYKHDZt4D5uyOjSy9wM0/iPDRA95K aRgSpcfkGQBCak/XRmKmZxyH6rgM0bMDpSqAKoVyWGBZ0gQift2893L6AMiqB0Zbq+8R lQdfqfB6Yw8jz+4DR+7k0fTaUEJo6pL6Wjsopgj2gTNvIajhXmocN8/WO34lLH0Xj6gO n93Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683839978; x=1686431978; 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=bX53ON7mzhZNh1r5Rt/vUAnbEJULUr8rQHsYs/xPHAk=; b=Ja6ih/z8ZOD6bBSuCk4S6f5SF4Egv+5ajFc+pFh7Cv48B6AxFyOjPIkVm1MfSDdiSr tz7EzLQWcl1FBqIxX3B3WveOzhZGwdVWIOoaqXkn8r5EKUKdXPyVcHb1/rtfCw0fNmUB BdmBwKPnGQpZY7jfh0J2ZxKS45XmVRMgbSoArrpx4NKnxMEuk1HDUdsCegKfPVkuRbuc ixq3EjISxwASkb9VvkYXXEiuUZUQLyrzRrxNdlRUMrJcqjXJXc4By3lL7QCIY0Zbz8Qg 0M4j+uV3kbaZRs5a0UzmZCbZ870UyECfni2rK5IMfGWy/uPf9uG6Eljswarg34ReCprM l7AA== X-Gm-Message-State: AC+VfDwK+7b8xKP9QrZbX04wHz6URwfAXV78SVBckQSeeFWA2QmpU1PX KH7iFjepGWyJ2hGRl4NaD3FKChAEzmg= X-Google-Smtp-Source: ACHHUZ5xzDyw0XHzRErVKE69RwaAsALgOGk5nN7n8N+D3Yo4zNmADipKbAkkYe9DXEx/N3uunjcK4Q== X-Received: by 2002:a5d:5942:0:b0:306:2e48:6ded with SMTP id e2-20020a5d5942000000b003062e486dedmr14683964wri.13.1683839978548; Thu, 11 May 2023 14:19:38 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id f5-20020adff985000000b002fda1b12a0bsm21703299wrr.2.2023.05.11.14.19.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 14:19:38 -0700 (PDT) Message-Id: <5fabe166714ba98c2583c35f2b25563248e90a6e.1683839975.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 21:19:29 +0000 Subject: [PATCH v2 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 cd4d724a0b7..58a7ea24606 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 Thu May 11 21:19:30 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13238467 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 7FCF4C7EE24 for ; Thu, 11 May 2023 21:20:01 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238084AbjEKVT7 (ORCPT ); Thu, 11 May 2023 17:19:59 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59950 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239333AbjEKVTn (ORCPT ); Thu, 11 May 2023 17:19:43 -0400 Received: from mail-wm1-x335.google.com (mail-wm1-x335.google.com [IPv6:2a00:1450:4864:20::335]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3C41B30C2 for ; Thu, 11 May 2023 14:19:41 -0700 (PDT) Received: by mail-wm1-x335.google.com with SMTP id 5b1f17b1804b1-3f450815d02so19037115e9.0 for ; Thu, 11 May 2023 14:19:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683839979; x=1686431979; 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=c9dO7Gs9CKGG6mYYiCrAJWyCRj0ROdSDFr4usoKEOQs=; b=TclkJMd0zCWLZQYgdU9bCA4Do9EV0qg3pn6qnEyD8BTkFiFwMZI/Rkr2m5SEs+Q7tp OCD6fUDnIJpQUomlNYTQ6eFejcVkFOS5CgRz+vYGwrqP7b5jcUvcPW5K5xKF9Khz6eE+ zN39VIBUbnU4MZzzCILP4TGtxIMBX3hFLp6k+PaVXdP33MSNIOJHoI9PabmfRyZSKLOe dyORmp6QwEJKTS/HhSn6a0X322kqLGGJTXR9fKMd0WHqmCdKnmiqqhJpm7J7aVxi+CGR UXGh4LW/YGxOziwZdNp3SKfMqZKsUIKpyOuP8DOPx+muH5YbpTCYkDuJAzdurju8KVYo svtg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683839979; x=1686431979; 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=c9dO7Gs9CKGG6mYYiCrAJWyCRj0ROdSDFr4usoKEOQs=; b=NYRvlK8zC6qMjwNpi7HZfohyyP/RHVDuwAL3fA1OPq3+sWQdTpsEujE4VbrdUYsCf1 4WWpGk6pUdrmnuyEAcRCu/S+CBGT0K2a+cjyXBu8VPfbxD3XxzZzv81GjZcYsPqLOoGY 2fS7ykJzZL6aEPX7Kx8enfUQZmqN7jEtDBUMLeJgEdBH9MhWN30ai7WYX9rslpqQJ8wS nqNK6yCuHp8YJuimMblGp96CjoG+MPy6XK8A2V76wltJWNenQXmchv3Xdbw85NLOYXfM A3IpUZNOwCwwa3rdoLMFB8sxpR8GUKvToFdBv0HT9xQ5WDspmobG1t0fKQOUdCeBOxG2 yI7A== X-Gm-Message-State: AC+VfDzPSFaRrhrrWilLxz9aoRMmUaZAEuI24GNnzHE0FeAezCrvue8V IIdpw9Vl74f0t5iEwqLB1YX49mkpBr8= X-Google-Smtp-Source: ACHHUZ40OyjC+JFMdjQAD8hsQM0r9BOkpJCU2GSftZUQ5ni2zagN9q0SAtFaCrk+mRlLSMa2V7ekRw== X-Received: by 2002:a05:600c:3657:b0:3f4:2267:10cf with SMTP id y23-20020a05600c365700b003f4226710cfmr11154324wmq.32.1683839979323; Thu, 11 May 2023 14:19:39 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id h5-20020a1ccc05000000b003ee5fa61f45sm26626088wmb.3.2023.05.11.14.19.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 14:19:39 -0700 (PDT) Message-Id: <783a0b1e00309e9bcf13494908d99317df72f0d6.1683839975.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 21:19:30 +0000 Subject: [PATCH v2 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 | 42 ++++++++++++------------ 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 58a7ea24606..8766edbf4dc 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. $ cat msg.txt | git interpret-trailers --trailer 'sign: Alice ' --trailer 'sign: Bob ' subject -message +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Signed-off-by: Alice 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 @@ -366,12 +366,12 @@ $ git config trailer.help.cmd "~/bin/glog-find-author" $ git interpret-trailers --trailer="help:Junio" --trailer="help:Couder" < subject > -> message +> Lorem ipsum dolor sit amet, consectetur adipiscing elit. > > EOF subject -message +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Helped-by: Junio C Hamano Helped-by: Christian Couder @@ -391,12 +391,12 @@ $ git config trailer.ref.cmd "~/bin/glog-grep" $ git interpret-trailers --trailer="ref:Add copyright notices." < subject > -> message +> Lorem ipsum dolor sit amet, consectetur adipiscing elit. > > EOF subject -message +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Reference-to: 8bc9a0c769 (Add copyright notices., 2005-04-07) ------------ @@ -412,13 +412,13 @@ $ git config trailer.see.command "git log -1 --oneline --format=\"%h (%s)\" --ab $ git interpret-trailers < subject > -> message +> Lorem ipsum dolor sit amet, consectetur adipiscing elit. > > see: HEAD~2 > EOF subject -message +Lorem ipsum dolor sit amet, consectetur adipiscing elit. See-also: fe3187489d69c4 (subject of related commit) ------------ From patchwork Thu May 11 21:19:31 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13238465 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 82C8FC77B7F for ; Thu, 11 May 2023 21:19:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239348AbjEKVTz (ORCPT ); Thu, 11 May 2023 17:19:55 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59934 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239312AbjEKVTn (ORCPT ); Thu, 11 May 2023 17:19:43 -0400 Received: from mail-wm1-x333.google.com (mail-wm1-x333.google.com [IPv6:2a00:1450:4864:20::333]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B16792D62 for ; Thu, 11 May 2023 14:19:41 -0700 (PDT) Received: by mail-wm1-x333.google.com with SMTP id 5b1f17b1804b1-3f423521b10so40440255e9.0 for ; Thu, 11 May 2023 14:19:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683839980; x=1686431980; 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=bzwX/7LRE0ikv3RBydDvvvCjp0wBMjNjtlRHqkAo8cM=; b=eNz3ztpR3GvQqBIWaTGerWEh7ktnwKzJH/hnVToR5/DBNIr4Q6s3O3OWvXogx4RCed 4zjufws9Mr380EVLyrhaBw8vvWxq4jp8UZPZVGWt/RLZFYL0JjqqhngTGJTrZBHMDGWj RGHINcTrx3kAwmdCWBIWvMRnR6V45zTayHK3tv0MCbs/FHsBzhywwiOXFZN312UKLafY vyzW3ASHJfCVAoU1HfdVvFGatGNLdj0gCluGA9KTX4WvnlF07E274YyfciDiqP/ynfDv ZrEoNzD88r32sBebWtZoXTdvfa0v+q62kqMJFtWQ68Uqwgzib6e2aFFVqfvoGQnpiKkf UXuQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683839980; x=1686431980; 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=bzwX/7LRE0ikv3RBydDvvvCjp0wBMjNjtlRHqkAo8cM=; b=PAvR5BUk7QcY2J5x7TxNm1FzUgJZgwm65iQc5era16kMr/roSboiu7/nc02IPPIxRh QzmPhVAJV8v7IPMlrSOAJEaiVgCkXtc+/empR1U3f8eYQ0iwJC1lKZ36E0t99XoLFKJy a4QiNmco2OWL09SmnyIHdPvwewZCtjjMq44ocm+8OVFDR5qSjGGVXaVKFIC69KNonIvn Zxt/fJXqr4DfqLRROYup063dx+bH9d84MYv52KXsPP8VcdfK5Vh3zxWi1hsA6RB/acAF WvbZkw5eVqmr9NG2nNsGIDdnBzYQ3fIoHSk2lClwQfVSp1TTqcoNIJt5U7Z+mKbfHB+Q 7S3A== X-Gm-Message-State: AC+VfDynU/Gjmgy5VJD37vlb8fLInBO0LGhvwj121dKJBm3Vz52pbVZn lgF3J/PXlQ0cnn2OQbj6YPBSGO6Q8+k= X-Google-Smtp-Source: ACHHUZ5BIZfumVEwHiNclRMNtAN4PMbAV+IxFllB0kDh5bBEuiS6BeFV9So+k/gY/nkM6ty5B44H9g== X-Received: by 2002:a1c:f402:0:b0:3f3:3a81:32b with SMTP id z2-20020a1cf402000000b003f33a81032bmr15890649wma.15.1683839979781; Thu, 11 May 2023 14:19:39 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id f12-20020a7bc8cc000000b003f4e4b5713esm4100221wml.37.2023.05.11.14.19.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 14:19:39 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Thu, 11 May 2023 21:19:31 +0000 Subject: [PATCH v2 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 8766edbf4dc..495d5c9bcf1 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 Thu May 11 21:19:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13238466 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 DB4E5C77B7C for ; Thu, 11 May 2023 21:19:58 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239384AbjEKVT6 (ORCPT ); Thu, 11 May 2023 17:19:58 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59964 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239342AbjEKVTn (ORCPT ); Thu, 11 May 2023 17:19:43 -0400 Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 68CAA2D5A for ; Thu, 11 May 2023 14:19:42 -0700 (PDT) Received: by mail-wr1-x435.google.com with SMTP id ffacd0b85a97d-3063891d61aso8730237f8f.0 for ; Thu, 11 May 2023 14:19:42 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683839980; x=1686431980; 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=oRGgCTSjmtIc5QXfDmjjUCqDoAVaLT7Rl9YgVHh+y8Q=; b=NJ1+5Rr2rMho0b433GAyzoWPiFIXS1JMNwroxuWfKgQBiggXTHNYD8XVn8l2CLp+DV 7Dk3uOtcqPHHYnH0OdTQ/s5vX4kJXI/h+Nvi0F7cX9ONVr3kgXbas9lJE4tqRq+0IBGI tJihlwL8U5BUDmzN0+tK45lj3HYwdZfFkyRu3u8r7t7iTrDEYwn4NBr3wS+Pd3fjL97Y lYGQmZnOfaKWfIQommbABbEqy/N6N1UEclGlhmnE3IFRnDfIc4WuEyub3+IGGcAwurGk nzINaOBVdmOwpQxth5Lrxok2G/PSXIcNdMGYxCJwiVlrj1uBmoH0R0tBYx2LXTeXbork qoDQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683839980; x=1686431980; 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=oRGgCTSjmtIc5QXfDmjjUCqDoAVaLT7Rl9YgVHh+y8Q=; b=Zqnx7XRTKxzeZ6GzjEoVHBP8qcJjjynhrWL3GmUKK4JQtvRwHq8SZ6tkFy/4i/urII oNxgMJAVsjAo2gSYtktSEW2WI5ELRS/Z+3UE+Ny9+8TlaKJkStHjInZMujCq/oXyhfZY FDxkW+QEpX5BOSs4LA6LGAvlUoOENPzmJGVWAZcCNs5mTqgXFJM75y3QZVfr63Rt9cAz 5iUGwFh3JHXmo8hKUf+QQBbVL/XV3hO7JKu/MtbvnLvHgoLD2+icNTW6beDZf8Q3Ksiw yBaljfnWZXw+8nt+CqB6Xw+r1dOaGMX5eiX4+U7D+lBhMvoNss1SFiS2Mt5BczAkcYJR pr/g== X-Gm-Message-State: AC+VfDwZwtw3Nnhm2ZmVE5/5DMqr5N70/6fK3xRIzFfzQl5afsjPNoqq UGaLuQeYWxcdV4VEc+Y1c+YmkXZ4614= X-Google-Smtp-Source: ACHHUZ6isjIILtdqZVyw2QtBFTS4rh7fLZsbdRLPTOA7ARQVxKFjTlBjQBHimghnbDEyL5IEiy9iHg== X-Received: by 2002:a5d:6dce:0:b0:306:db7b:bb2d with SMTP id d14-20020a5d6dce000000b00306db7bbb2dmr15198342wrz.38.1683839980645; Thu, 11 May 2023 14:19:40 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id w14-20020a5d680e000000b003079693eff2sm13480771wru.41.2023.05.11.14.19.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 14:19:40 -0700 (PDT) Message-Id: <96cb4ae2965772666457ea84cfc2cfc42e06bbf4.1683839975.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 21:19:32 +0000 Subject: [PATCH v2 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 495d5c9bcf1..576f5987b0d 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 Thu May 11 21:19:33 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13238469 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 39418C77B7C for ; Thu, 11 May 2023 21:20:08 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239410AbjEKVUG (ORCPT ); Thu, 11 May 2023 17:20:06 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60002 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239357AbjEKVTp (ORCPT ); Thu, 11 May 2023 17:19:45 -0400 Received: from mail-wr1-x42c.google.com (mail-wr1-x42c.google.com [IPv6:2a00:1450:4864:20::42c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5FE002D62 for ; Thu, 11 May 2023 14:19:43 -0700 (PDT) Received: by mail-wr1-x42c.google.com with SMTP id ffacd0b85a97d-3062c1e7df8so6164808f8f.1 for ; Thu, 11 May 2023 14:19:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683839981; x=1686431981; 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=ajl3QhP6/tGo30bAxsGADp0s0Z+beaQMLvv02Yfb8Y8=; b=YP95+21unrDrO/MoBR7I4BVSTNM2T1eH+OkT+hQl5rmcMQgtiDPxpqwDEFXxShZON9 W/KZXJoFzAHp3OcgiTLRMdYRvK4Qj4QR6F7iCgfUzX3CZ3VY6E73BWGiMLgyEz6E4joQ 2wbGx4VmHBnIY/yFRTaO7ALdVs1jYk8kWfoLZOh2Ehfugn1/L7dPasAZ/c++1Tc4l0xa n6d/Vg/LTnbFwxTDplQRWJvsax9VHHIKd6NBxRucKZRvF0bLS/2S6ovoXUAi3y3OR2wJ 9qYoRnRNmXmkIsv28NgCzz0cONpDBh0R2IuzolTn679qWx0Quq7NUfY29FcWoYI2ttgE V/zA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683839981; x=1686431981; 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=ajl3QhP6/tGo30bAxsGADp0s0Z+beaQMLvv02Yfb8Y8=; b=Qy+RVqNXQ2qMqblWmip+cIHbQMTJmkeFgWu/Lu7YAAFwlif42hRtph8CW+6XHv9ZJH IxO1JLnLfUO1YsQHrocmiykdB42grfDXQaAdak5faD46prwHrwn1n/9PJiyU5paMSSlb U/roJ1par0RR9p+sHubjKF6LxQ+gNt6gdFLi3bQlz2PvfyNb8QhIalljy5TxzznNRDLd bhWdIehmeulkA9xtMc4tIC7NMOy7gzgZ3U3dMcoo0jTVlMFlJC/jwRw4GpbqLRZJ4uc0 iwzLiyAb7xOkT6phRWB9aQlHHrTiJlVmE55xKdwBt9IQN3bfwyOyVz6XlqYh9k7i00tn cf2A== X-Gm-Message-State: AC+VfDydrgL0FF+qJgEHgD3VAWCIL7gkCkHkmp6GcE83w9tsteBw9+G5 FaVmpIDtPMyed5q6z5oZXTQuwuB+FJI= X-Google-Smtp-Source: ACHHUZ4s1SYV2jfSRMa6OUXbFaR+9uh8HFW89JSpnXHX3p8UYEY/rkfuXadlM75SWM5Q/HTRgx4iRw== X-Received: by 2002:adf:e9cc:0:b0:306:297b:927f with SMTP id l12-20020adfe9cc000000b00306297b927fmr15028538wrn.25.1683839981374; Thu, 11 May 2023 14:19:41 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id l15-20020a7bc44f000000b003f4e3ed98ffsm4760158wmi.35.2023.05.11.14.19.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 14:19:40 -0700 (PDT) Message-Id: <4e234110ffd2e6030f929b5179e62d722fcacb6d.1683839975.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 21:19:33 +0000 Subject: [PATCH v2 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 576f5987b0d..32a26c59f8a 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 Thu May 11 21:19:34 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13238470 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 AE81CC7EE24 for ; Thu, 11 May 2023 21:20:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239430AbjEKVUI (ORCPT ); Thu, 11 May 2023 17:20:08 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60008 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239364AbjEKVTp (ORCPT ); Thu, 11 May 2023 17:19:45 -0400 Received: from mail-wr1-x436.google.com (mail-wr1-x436.google.com [IPv6:2a00:1450:4864:20::436]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D606A3C30 for ; Thu, 11 May 2023 14:19:43 -0700 (PDT) Received: by mail-wr1-x436.google.com with SMTP id ffacd0b85a97d-3077d134028so5310032f8f.3 for ; Thu, 11 May 2023 14:19:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683839982; x=1686431982; 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=nJNQBIN8cv2IchSTc2C2hIT3DWCVK/uxXNnC+904g2s=; b=Uac8k5GOC8KVtT5WyRNb+OAkugwDHgwKK6N7lCMmPIFRut2npXsywh3hZHf3uoVtp8 zgu4+i6QpwDDqGEylxVW9Ahfi9SeAf5J752/G5eIdu6NgZo5iKdG2lG9CsavfQULSDrR r5fqpChkG7TuxbIUJTqRc+ZbvxIT/v0AuAV0TnSt2Bkg9klYZv6hdEn+a+iwLiswe9SI TNqlWE2+NjE2/MMqWI/mxxNUXNwo+6PhqN1iEWHqYGK/2xJjwTaT20earbfLjyhKbIo+ n8XADrZ7RFcSWQOzxb9vmcTXFSNEkBFpkNO0TXGs14dEmYHEUQgD3Q9FhSqcn7HHvwFR p7ww== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683839982; x=1686431982; 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=nJNQBIN8cv2IchSTc2C2hIT3DWCVK/uxXNnC+904g2s=; b=GhH67Pqwhp+WD+qDcBJGsQBHfPtBJ+c8q4zEh0btMgIk2M/AwGjbTQTnX7BdrYXs6O cZTLkJtZjzL3Zr92gH1At0WO1mQfMiSJ8+Sa5cyBt43WkTn95eTDWaFP4ujf7XqwidWE c0Q9r0ctju3091s0mEua+Q/GINsPncVoqozaMxXGWttr2poxGnW+oBoHJJ3CxhVmXe3p j3T4xs//lcJ6dKIZQd5cjmHKMjHMPBpHB+cspTQgVVO3wFA8LzEJpKgI4dDuRhQyHfXU nQWLZnrnyKvrjOG7BF+6r+t/oYfFlPXFGNFPrXvgmmOrWScT2ds1Bxdwxwh/pVQqqGMk TtNw== X-Gm-Message-State: AC+VfDzKhY6RYGJ/IlzxWRCxX7aknuf9idCN7onJL4vX3hB8ZI5+NCO0 m3Yyyf8GvNfV2ozuYCJhd7eu79P5vDE= X-Google-Smtp-Source: ACHHUZ4HekGXl1VPouv+MXKm+nouQQymhziuD/fIijvqj+xdEEDxl0b70h1AKd4oKjUxNE2IBxLz1g== X-Received: by 2002:a5d:40cf:0:b0:306:39a8:6fa2 with SMTP id b15-20020a5d40cf000000b0030639a86fa2mr13989720wrq.61.1683839982118; Thu, 11 May 2023 14:19:42 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id o17-20020a5d4091000000b003078a3f3a24sm17693758wrp.114.2023.05.11.14.19.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 14:19:41 -0700 (PDT) Message-Id: <8aaf9e27d98cc823efaa9032a07cb2994a3cae48.1683839975.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 21:19:34 +0000 Subject: [PATCH v2 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 32a26c59f8a..245a66a7a85 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 Thu May 11 21:19:35 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Arver X-Patchwork-Id: 13238468 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 CFF92C77B7C for ; Thu, 11 May 2023 21:20:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239428AbjEKVUB (ORCPT ); Thu, 11 May 2023 17:20:01 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60028 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239365AbjEKVTq (ORCPT ); Thu, 11 May 2023 17:19:46 -0400 Received: from mail-wr1-x431.google.com (mail-wr1-x431.google.com [IPv6:2a00:1450:4864:20::431]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8DAA530C2 for ; Thu, 11 May 2023 14:19:44 -0700 (PDT) Received: by mail-wr1-x431.google.com with SMTP id ffacd0b85a97d-307664010fdso8450824f8f.0 for ; Thu, 11 May 2023 14:19:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683839982; x=1686431982; 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=/HxxF6Jn5d97srhMye+JDTpTFGjXfZNv0Ucvbw9dv0o=; b=nvXvSISr2oDqvc8dMxGzE8BTCXbBMxvIUj8OA3YMtZ4XGQjUElhez5TjdAGQeAc4zW ukBBT+kQGdjO4QPFGa8LDzECmRUQ5n+kzLpzSE/SorZiZ/8GIZdODFsmB+ptmw46cVUQ WqoHAtLp5QkHK1h8aVuXpmSiYHdgA26RNPZkX05KtRt1fHqlUb2uKSj7A+XLiIW5LEZt WMkRpJvwzFjgrM1ewk0AegUnVmQ6Fvr+23DBGmBMEDm3Y5ExUxVRNBW7VfPMXnK4EnWi V/4nldv7qCYctb2kaRSGZy1pLrlWF4urRdZ0IHTJfelufA5hCCjfHKhAbwlX6sKLUWMZ AS1A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683839982; x=1686431982; 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=/HxxF6Jn5d97srhMye+JDTpTFGjXfZNv0Ucvbw9dv0o=; b=A94GUd+8NFIJZsMy00wIOBdlfHb6vGfnY6NXaWLuKTzNWQy2f3rJDb1xs5FM/m9GgZ oc8HItQ8Hu+SuktNCxdJOjfQfIuhnXRC014taPFNMQkboFR4cz98tslM/lVTxtMqSNK7 /zfmy2Zf7WM6wkRb332zNREI+A8RalSK0NZ9zthaOnBzDezlXVMxLhXNGsMQiTyAPpFg ViKjYS3P57VSpuJpZTcJcZ1Xp2086H1dGmRtn/t+mr82/0QFp4HJHEmEqogsxz4sXk9u TsqXeRuvjzn+VakTvlBUoqUUOZHKzdla+g4miBQOnxjy/jgy2cFen9SMngJjZO4ZGwsA kjSg== X-Gm-Message-State: AC+VfDxBTRWAAd+OnestXH70exxPn/DHnNGogZ1ndAvwoudlqgLFlkpR M95JkvF70PCoi44DgMbxlfhXI6j/a1U= X-Google-Smtp-Source: ACHHUZ6jqNw0jtKcMcfsPZ7H+VSLHml2KrYbdCV+Pb38AAtwOH6LdsHi/GUZyEF85gdQIw3xNqOB6Q== X-Received: by 2002:a05:6000:10d2:b0:307:8e1b:6ce2 with SMTP id b18-20020a05600010d200b003078e1b6ce2mr11457988wrx.16.1683839982794; Thu, 11 May 2023 14:19:42 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id l4-20020a5d4104000000b00304832cd960sm21342543wrp.10.2023.05.11.14.19.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 14:19:42 -0700 (PDT) Message-Id: <7e95198894b7de9b3d16dfa7d686b5fe3bced5b4.1683839975.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 21:19:35 +0000 Subject: [PATCH v2 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 245a66a7a85..e13a5ec6943 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.