From: ZheNing Hu <adlternative@gmail.com> To: Christian Couder <christian.couder@gmail.com> Cc: ZheNing Hu via GitGitGadget <gitgitgadget@gmail.com>, git <git@vger.kernel.org>, Junio C Hamano <gitster@pobox.com> Subject: Re: [PATCH v8 2/2] [GSOC] trailer: add new .cmd config option Date: Sat, 10 Apr 2021 22:09:39 +0800 [thread overview] Message-ID: <CAOLTT8SHu6HmuZYGSz2aboMi8M4Qzf5dZL_k=CUH5Yo-qAu2cw@mail.gmail.com> (raw) In-Reply-To: <CAP8UFD2A+9eaMGdK9cCfz9Kmz9w-bgiV6x7=X2Y-hmSNAuAV=Q@mail.gmail.com> Christian Couder <christian.couder@gmail.com> 于2021年4月10日周六 上午4:19写道: > > On Fri, Apr 9, 2021 at 3:37 PM ZheNing Hu via GitGitGadget > <gitgitgadget@gmail.com> wrote: > > > > From: ZheNing Hu <adlternative@gmail.com> > > > > The `trailer.<token>.command` configuration variable > > specifies a command (run via the shell, so it does not have > > to be a single name of or path to the command, but can be a > > s/of or/or/ > > > shell script), and the first occurrence of substring $ARG is > > replaced with the value given to the `interpret-trailer` > > command for the token. This has two downsides: > > Maybe: s/for the token/for the token in a '--trailer <token>=<value>' argument/ > > > * The use of $ARG in the mechanism misleads the users that > > the value is passed in the shell variable, and tempt them > > to use $ARG more than once, but that would not work, as > > the second and subsequent $ARG are not replaced. > > > > * Because $ARG is textually replaced without regard to the > > shell language syntax, even '$ARG' (inside a single-quote > > pair), which a user would expect to stay intact, would be > > replaced, and worse, if the value had an unmatched single > > quote (imagine a name like "O'Connor", substituted into > > NAME='$ARG' to make it NAME='O'Connor'), it would result in > > a broken command that is not syntactically correct (or > > worse). > > > > Introduce a new `trailer.<token>.cmd` configuration that > > takes higher precedence to deprecate and eventually remove > > `trailer.<token>.command`, which passes the value as an > > argument to the command. Instead of "$ARG", users can > > refer to the value as positional argument, $1, in their > > scripts. > > Good! > > > Helped-by: Junio C Hamano <gitster@pobox.com> > > Helped-by: Christian Couder <christian.couder@gmail.com> > > Signed-off-by: ZheNing Hu <adlternative@gmail.com> > > --- > > Documentation/git-interpret-trailers.txt | 90 ++++++++++++++++++++---- > > t/t7513-interpret-trailers.sh | 84 ++++++++++++++++++++++ > > trailer.c | 37 +++++++--- > > 3 files changed, 187 insertions(+), 24 deletions(-) > > > > diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt > > index 3e5aa3a65ae9..1a874a93f49b 100644 > > --- a/Documentation/git-interpret-trailers.txt > > +++ b/Documentation/git-interpret-trailers.txt > > @@ -236,21 +236,38 @@ trailer.<token>.command:: > > be called to automatically add or modify a trailer with the > > specified <token>. > > + > > -When this option is specified, the behavior is as if a special > > -'--trailer <token>=<value>' argument was added at the beginning of > > -the "git interpret-trailers" command, where <value> is taken to be the > > -standard output of the specified command with any leading and trailing > > -whitespace trimmed off. > > +When this option is specified, the first occurrence of substring $ARG is > > +replaced with the value given to the `interpret-trailer` command for the > > +same token. It passes the value through `$ARG`, otherwise this option behaves > > +in the same way as 'trailer.<token>.cmd'. > > Actually I think that we should say first that this behaves in the > same way as the 'trailer.<token>.cmd'. > > And this should also replace the first paragraph in the description of > 'trailer.<token>.command', not just the second one. > Make sence. After all, the primary purpose of this patch is to show that ".command" has been deprecated. > Maybe: > > "This option behaves in the same way as 'trailer.<token>.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." > > > +The 'trailer.<token>.command' option has been deprecated due to the fact > > s/deprecated/deprecated in favor of 'trailer.<token>.cmd'/ > > > +that $ARG in the user's command can only be replaced once and that the > > s/can only be/is only/ > > > +original way of replacing $ARG was not safe. > > s/was/is/ > > > Now the preferred option is 'trailer.<token>.cmd', which uses a positional argument to pass the value. > > I think we can remove this sentence especially if we say "deprecated > in favor of 'trailer.<token>.cmd'" above. > I agree. > > -The first occurrence of substring `$ARG` will be replaced with the > > -<value> part of an existing trailer with the same <token>, if any, > > -before the command is launched. > > +When both 'trailer.<token>.cmd' and 'trailer.<token>.command' are given > > +for the same <token>, 'trailer.<token>.cmd' is used and > > +'trailer.<token>.command' is ignored. > > Ok. > > > +trailer.<token>.cmd:: > > I think we should base the description of this option on what I > suggest in patch 1/2. So let's agree on patch 1/2 before discussing > this. Yes, The description of the new .cmd is best approximated by the .command in 1/2 . I should @Junio, I don't know if he has any other opinions. -- ZheNing Hu
next prev parent reply other threads:[~2021-04-10 14:10 UTC|newest] Thread overview: 101+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-03-23 14:53 [PATCH] [GSOC]trailer: change $ARG to environment variable ZheNing Hu via GitGitGadget 2021-03-24 15:42 ` [PATCH v2] [GSOC]trailer: pass arg as positional parameter ZheNing Hu via GitGitGadget 2021-03-24 20:18 ` Junio C Hamano 2021-03-25 1:43 ` ZheNing Hu 2021-03-25 11:53 ` [PATCH v3] " ZheNing Hu via GitGitGadget 2021-03-25 22:28 ` Junio C Hamano 2021-03-26 13:29 ` ZheNing Hu 2021-03-26 16:13 ` [PATCH v4] " ZheNing Hu via GitGitGadget 2021-03-27 18:04 ` Junio C Hamano 2021-03-27 19:53 ` Christian Couder 2021-03-28 10:46 ` ZheNing Hu 2021-03-29 9:04 ` Christian Couder 2021-03-29 13:43 ` ZheNing Hu 2021-03-30 8:45 ` Christian Couder 2021-03-30 11:22 ` ZheNing Hu 2021-03-30 15:07 ` ZheNing Hu 2021-03-30 17:14 ` Junio C Hamano 2021-03-31 5:14 ` ZheNing Hu 2021-03-31 18:19 ` Junio C Hamano 2021-03-31 18:29 ` Junio C Hamano 2021-04-01 3:56 ` ZheNing Hu 2021-04-01 19:49 ` Junio C Hamano 2021-04-02 2:08 ` ZheNing Hu 2021-04-01 3:39 ` ZheNing Hu 2021-03-31 10:05 ` [PATCH v5 0/2] " ZheNing Hu via GitGitGadget 2021-03-31 10:05 ` [PATCH v5 1/2] [GSOC] run-command: add shell_no_implicit_args option ZheNing Hu via GitGitGadget 2021-04-01 7:22 ` Christian Couder 2021-04-01 9:58 ` ZheNing Hu 2021-03-31 10:05 ` [PATCH v5 2/2] [GSOC]trailer: pass arg as positional parameter ZheNing Hu via GitGitGadget 2021-04-01 7:28 ` [PATCH v5 0/2] " Christian Couder 2021-04-01 10:02 ` ZheNing Hu 2021-04-02 13:26 ` [PATCH v6] [GSOC] trailer: add new trailer.<token>.cmd config option ZheNing Hu via GitGitGadget 2021-04-02 20:48 ` Junio C Hamano 2021-04-03 5:08 ` ZheNing Hu 2021-04-04 5:34 ` Junio C Hamano 2021-04-03 5:51 ` Christian Couder 2021-04-04 23:26 ` Junio C Hamano 2021-04-06 3:47 ` Christian Couder 2021-04-06 3:52 ` Christian Couder 2021-04-06 5:16 ` ZheNing Hu 2021-04-06 5:34 ` Junio C Hamano 2021-04-06 5:37 ` Junio C Hamano 2021-04-04 5:43 ` ZheNing Hu 2021-04-04 8:52 ` Christian Couder 2021-04-04 9:53 ` ZheNing Hu 2021-04-02 23:44 ` Junio C Hamano 2021-04-03 3:22 ` ZheNing Hu 2021-04-03 4:31 ` Junio C Hamano 2021-04-03 5:15 ` ZheNing Hu 2021-04-04 13:11 ` [PATCH v7] " ZheNing Hu via GitGitGadget 2021-04-06 16:23 ` Christian Couder 2021-04-07 4:51 ` ZheNing Hu 2021-04-09 13:37 ` [PATCH v8 0/2] [GSOC] trailer: add new .cmd " ZheNing Hu via GitGitGadget 2021-04-09 13:37 ` [PATCH v8 1/2] [GSOC] docs: correct descript of trailer.<token>.command ZheNing Hu via GitGitGadget 2021-04-09 19:02 ` Christian Couder 2021-04-10 13:40 ` ZheNing Hu 2021-04-09 13:37 ` [PATCH v8 2/2] [GSOC] trailer: add new .cmd config option ZheNing Hu via GitGitGadget 2021-04-09 20:18 ` Christian Couder 2021-04-10 14:09 ` ZheNing Hu [this message] 2021-04-09 19:59 ` [PATCH v8 0/2] " Christian Couder 2021-04-12 16:39 ` [PATCH v9 " ZheNing Hu via GitGitGadget 2021-04-12 16:39 ` [PATCH v9 1/2] [GSOC] docs: correct descript of trailer.<token>.command ZheNing Hu via GitGitGadget 2021-04-12 20:42 ` Junio C Hamano 2021-04-16 12:03 ` Christian Couder 2021-04-17 1:54 ` Junio C Hamano 2021-04-12 16:39 ` [PATCH v9 2/2] [GSOC] trailer: add new .cmd config option ZheNing Hu via GitGitGadget 2021-04-12 20:51 ` Junio C Hamano 2021-04-13 7:33 ` Christian Couder 2021-04-13 12:02 ` ZheNing Hu 2021-04-13 19:18 ` Junio C Hamano 2021-04-14 13:27 ` ZheNing Hu 2021-04-14 20:33 ` Junio C Hamano 2021-04-15 15:32 ` ZheNing Hu 2021-04-15 17:41 ` Junio C Hamano 2021-04-16 12:54 ` Christian Couder 2021-04-13 18:14 ` Junio C Hamano 2021-04-16 8:47 ` [PATCH v10 0/2] " ZheNing Hu via GitGitGadget 2021-04-16 8:47 ` [PATCH v10 1/2] [GSOC] docs: correct descript of trailer.<token>.command ZheNing Hu via GitGitGadget 2021-04-16 19:11 ` Junio C Hamano 2021-04-16 8:47 ` [PATCH v10 2/2] [GSOC] trailer: add new .cmd config option ZheNing Hu via GitGitGadget 2021-04-16 19:13 ` Junio C Hamano 2021-04-16 19:21 ` Junio C Hamano 2021-04-16 19:25 ` Junio C Hamano 2021-04-17 2:58 ` Junio C Hamano 2021-04-17 3:36 ` Junio C Hamano 2021-04-17 7:41 ` ZheNing Hu 2021-04-17 8:11 ` Junio C Hamano 2021-04-17 15:13 ` [PATCH v11 0/2] " ZheNing Hu via GitGitGadget 2021-04-17 15:13 ` [PATCH v11 1/2] [GSOC] docs: correct description of .command ZheNing Hu via GitGitGadget 2021-04-17 15:13 ` [PATCH v11 2/2] [GSOC] trailer: add new .cmd config option ZheNing Hu via GitGitGadget 2021-04-17 22:26 ` [PATCH v11 0/2] " Junio C Hamano 2021-04-18 7:47 ` ZheNing Hu 2021-04-21 0:09 ` Junio C Hamano 2021-04-21 5:47 ` ZheNing Hu 2021-04-21 23:40 ` Junio C Hamano 2021-04-22 9:20 ` ZheNing Hu 2021-04-27 6:49 ` Junio C Hamano 2021-04-27 12:24 ` ZheNing Hu 2021-05-03 15:41 ` [PATCH v12 " ZheNing Hu via GitGitGadget 2021-05-03 15:41 ` [PATCH v12 1/2] [GSOC] docs: correct descript of trailer.<token>.command ZheNing Hu via GitGitGadget 2021-05-03 15:41 ` [PATCH v12 2/2] [GSOC] trailer: add new .cmd config option ZheNing Hu via GitGitGadget
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: http://vger.kernel.org/majordomo-info.html * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to='CAOLTT8SHu6HmuZYGSz2aboMi8M4Qzf5dZL_k=CUH5Yo-qAu2cw@mail.gmail.com' \ --to=adlternative@gmail.com \ --cc=christian.couder@gmail.com \ --cc=git@vger.kernel.org \ --cc=gitgitgadget@gmail.com \ --cc=gitster@pobox.com \ --subject='Re: [PATCH v8 2/2] [GSOC] trailer: add new .cmd config option' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Code repositories for project(s) associated with this inbox: https://80x24.org/mirrors/git.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).