Re: [PATCH v2] refs: fix duplicated word in comment
- From
- Martin Ågren <martin.agren@gmail.com>
- Date
- Apr 7, 2025, 18:43 UTC
- Message-ID
- <CAN0heSoh4SuQcYHVVniO1BYH_C4O-BeF4kKxDg3uQPzpotLA1A@mail.gmail.com>
- In-Reply-To
- <pull.1940.v2.git.git.1743857867327.gitgitgadget@gmail.com>
On Sat, 5 Apr 2025 at 14:58, Christian Fredrik Johnsen via GitGitGadget <gitgitgadget@gmail.com> wrote:
Show 6 quoted lines
> > From: Christian Fredrik Johnsen <christian@johnsen.no> > > Fix a typo in a comment in refs.c: "checking checking" → "checking". > > Signed-off-by: Christian Fredrik Johnsen <christian@johnsen.no>
This addresses my comment on v1.
Show 7 quoted lines
> Changes since v1: > > * Add a blank line in the commit message to separate commit body from > Signed-off-by: footer > * Moved the word common from line 2553 to 2552, to make the comment be > similar in style to other comments in refs.c. (Usually the last > comment line is somewhat shorter than the first ones).
Show 9 quoted lines
> /* > * If we've already seen the directory we don't need to > - * process it again. Skip it to avoid checking checking > - * common prefixes like "refs/heads/" repeatedly. > + * process it again. Skip it to avoid checking common > + * prefixes like "refs/heads/" repeatedly. > */ > if (!strset_add(&dirnames, dirname.buf)) > continue;
Ok. In general, there's some trade-off to be made between "make a small change at the top of a twenty-line comment and rewrap the whole thing causing more churn than necessary and create more room for conflicts with other topics" and "make the change and live with slightly less beautiful wrapping". In this particular case, the blast radius is small. `git show --word-diff` confirms that you simply removed the duplicate word and moved "common" (or "*").
FWIW, this patch looks good to me.
Martin