| Message ID | pull.685.git.1595993608886.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 84544f2ea3441a5715fc3e2dfbb025083872fac5 |
| Headers | show |
| Series | comment: fix spelling mistakes inside comments | expand |
On 7/28/20 11:33 PM, Steve Kemp via GitGitGadget wrote: > From: Steve Kemp <steve@steve.org.uk> > > This commit fixes a couple of minor spelling mistakes inside > comments. > > Signed-off-by: Steve Kemp <steve@steve.fi> > Signed-off-by: Steve Kemp <steve@steve.org.uk> Double sign-off? Perhaps keep the org.uk version, since that is the email you use for authorship. > - /* abandonded */ > + /* abandoned */ > -/* Print a cell to stdout with all necessary leading/traling space */ > +/* Print a cell to stdout with all necessary leading/trailing space */ > - * currenty thread-safe and might be racy with object reading, > + * currently thread-safe and might be racy with object reading, > - * 1. Only a single level of inderection is obtained, we might want to > + * 1. Only a single level of indirection is obtained, we might want to These edits are all positive ones. I'll leave it to more experienced contributors to comment on how a comment-only patch fits with this section Documentation/CodingGuidelines: - Fixing style violations while working on a real change as a preparatory clean-up step is good, but otherwise avoid useless code churn for the sake of conforming to the style. In my opinion, this change is not harmful, but also isn't super necessary. I could go either way. Thanks, -Stolee
On Wed, 29 Jul 2020 at 16:45, Derrick Stolee <stolee@gmail.com> wrote: > Double sign-off? Perhaps keep the org.uk version, since that > is the email you use for authorship. Sorry, thanks. > In my opinion, this change is not harmful, but also isn't super > necessary. I could go either way. If it were a white-space change, or a some trivial style-guide fixup I'd have left it alone. As it is the patch fixes a couple of mistakes, albeit trivial ones, I thought it was worth submitting. I'd be happy to see it merged, or dropped, whichever seems most appropriate. I appreciate it is internal and not user-visible, but when I read comments with typos in them they jump out! Updated patch, trivially, below. Steve
Derrick Stolee <stolee@gmail.com> writes: > I'll leave it to more experienced contributors to comment on how a > comment-only patch fits with this section Documentation/CodingGuidelines: > > - Fixing style violations while working on a real change as a > preparatory clean-up step is good, but otherwise avoid useless code > churn for the sake of conforming to the style. > > In my opinion, this change is not harmful, but also isn't super > necessary. I could go either way. Typofixes in comments has no chance of breaking things than a carelessly done code churn made in the name of cleaning up, so cost-benefit comparison is much more favourable. I'm sure that I won't be exhausted after reviewing comment-only patch as much as after reviewing code-churn only patch.
On 7/29/2020 2:16 PM, Junio C Hamano wrote: > Derrick Stolee <stolee@gmail.com> writes: > >> I'll leave it to more experienced contributors to comment on how a >> comment-only patch fits with this section Documentation/CodingGuidelines: >> >> - Fixing style violations while working on a real change as a >> preparatory clean-up step is good, but otherwise avoid useless code >> churn for the sake of conforming to the style. >> >> In my opinion, this change is not harmful, but also isn't super >> necessary. I could go either way. > > Typofixes in comments has no chance of breaking things than a > carelessly done code churn made in the name of cleaning up, so > cost-benefit comparison is much more favourable. I'm sure that I > won't be exhausted after reviewing comment-only patch as much as > after reviewing code-churn only patch. Thanks. I appreciate the context that provides more clarity. Steve's patch with the de-duplicated sign-off has my full support. -Stolee
diff --git a/add-patch.c b/add-patch.c index f899389e2c..a1d66c1b75 100644 --- a/add-patch.c +++ b/add-patch.c @@ -1203,7 +1203,7 @@ static int edit_hunk_loop(struct add_p_state *s, for (;;) { int res = edit_hunk_manually(s, hunk); if (res == 0) { - /* abandonded */ + /* abandoned */ *hunk = backup; return -1; } diff --git a/column.c b/column.c index 4a38eed322..a58969baba 100644 --- a/column.c +++ b/column.c @@ -107,7 +107,7 @@ static void display_plain(const struct string_list *list, printf("%s%s%s", indent, list->items[i].string, nl); } -/* Print a cell to stdout with all necessary leading/traling space */ +/* Print a cell to stdout with all necessary leading/trailing space */ static int display_cell(struct column_data *data, int initial_width, const char *empty_cell, int x, int y) { diff --git a/grep.c b/grep.c index 13232a904a..54af9f813e 100644 --- a/grep.c +++ b/grep.c @@ -1817,7 +1817,7 @@ static int grep_source_1(struct grep_opt *opt, struct grep_source *gs, int colle * We might set up the shared textconv cache data here, which * is not thread-safe. Also, get_oid_with_context() and * parse_object() might be internally called. As they are not - * currenty thread-safe and might be racy with object reading, + * currently thread-safe and might be racy with object reading, * obj_read_lock() must be called. */ grep_attr_lock(); diff --git a/ref-filter.c b/ref-filter.c index 8447cb09be..f836f3830c 100644 --- a/ref-filter.c +++ b/ref-filter.c @@ -1980,7 +1980,7 @@ static int for_each_fullref_in_pattern(struct ref_filter *filter, * of oids. If the given ref is a tag, check if the given tag points * at one of the oids in the given oid array. * NEEDSWORK: - * 1. Only a single level of inderection is obtained, we might want to + * 1. Only a single level of indirection is obtained, we might want to * change this to account for multiple levels (e.g. annotated tags * pointing to annotated tags pointing to a commit.) * 2. As the refs are cached we might know what refname peels to without