# [PATCH] blame: fix typo in documentation 16 messages from 2021-06-18 to 2021-06-29. Participants: Andrei Rybak, Bagas Sanjaya, Felipe Contreras, Barret Rhoden, Carlo Marcelo Arenas Belón, Junio C Hamano. Thread: https://gitlist.dev/t/55965 ## Andrei Rybak, 2021-06-18 22:11 Subject: [PATCH] blame: fix typo in documentation Message-ID: <20210618221104.42260-1-rybak.a.v@gmail.com> URL: https://gitlist.dev/e/20210618221104.42260-1-rybak.a.v%40gmail.com ``` As can be seen in files "Documentation/blame-options.txt" and "builtin/blame.c", the name of this configuration variable is "blame.markUnblamableLines". Signed-off-by: Andrei Rybak --- Documentation/config/blame.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/config/blame.txt b/Documentation/config/blame.txt index 9468e8599c..4d047c1790 100644 --- a/Documentation/config/blame.txt +++ b/Documentation/config/blame.txt @@ -27,7 +27,7 @@ blame.ignoreRevsFile:: file names will reset the list of ignored revisions. This option will be handled before the command line option `--ignore-revs-file`. -blame.markUnblamables:: +blame.markUnblamableLines:: Mark lines that were changed by an ignored revision that we could not attribute to another commit with a '*' in the output of linkgit:git-blame[1]. -- 2.32.0 ``` ## Bagas Sanjaya, 2021-06-19 05:27 Subject: Re: [PATCH] blame: fix typo in documentation Message-ID: <8921ac50-e628-9a60-2a8d-1b8cc2a5a056@gmail.com> URL: https://gitlist.dev/e/8921ac50-e628-9a60-2a8d-1b8cc2a5a056%40gmail.com In-Reply-To: <20210618221104.42260-1-rybak.a.v@gmail.com> ``` Hi, On 19/06/21 05.11, Andrei Rybak wrote: > As can be seen in files "Documentation/blame-options.txt" and > "builtin/blame.c", the name of this configuration variable is > "blame.markUnblamableLines". > > Signed-off-by: Andrei Rybak > --- > Documentation/config/blame.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/config/blame.txt b/Documentation/config/blame.txt > index 9468e8599c..4d047c1790 100644 > --- a/Documentation/config/blame.txt > +++ b/Documentation/config/blame.txt > @@ -27,7 +27,7 @@ blame.ignoreRevsFile:: > file names will reset the list of ignored revisions. This option will > be handled before the command line option `--ignore-revs-file`. > > -blame.markUnblamables:: > +blame.markUnblamableLines:: > Mark lines that were changed by an ignored revision that we could not > attribute to another commit with a '*' in the output of > linkgit:git-blame[1]. > That above is not typo fixing; that is correcting configuration variable name. PS: I have to download mbox of this thread and reply from it because I didn't receive the thread on my Thunderbird, regardless of CCing Git ML. -- An old man doll... just what I always wanted! - Clara ``` ## Andrei Rybak, 2021-06-19 11:12 Subject: Re: [PATCH] blame: fix typo in documentation Message-ID: <7cbbd59b-d5e3-4b96-a1ee-a242a7839028@gmail.com> URL: https://gitlist.dev/e/7cbbd59b-d5e3-4b96-a1ee-a242a7839028%40gmail.com In-Reply-To: <8921ac50-e628-9a60-2a8d-1b8cc2a5a056@gmail.com> ``` On 19/06/2021 07:27, Bagas Sanjaya wrote: > On 19/06/21 05.11, Andrei Rybak wrote: >> As can be seen in files "Documentation/blame-options.txt" and >> "builtin/blame.c", the name of this configuration variable is >> "blame.markUnblamableLines". >> >> Signed-off-by: Andrei Rybak >> --- >>   Documentation/config/blame.txt | 2 +- >>   1 file changed, 1 insertion(+), 1 deletion(-) >> >> diff --git a/Documentation/config/blame.txt >> b/Documentation/config/blame.txt >> index 9468e8599c..4d047c1790 100644 >> --- a/Documentation/config/blame.txt >> +++ b/Documentation/config/blame.txt >> @@ -27,7 +27,7 @@ blame.ignoreRevsFile:: >>       file names will reset the list of ignored revisions.  This >> option will >>       be handled before the command line option `--ignore-revs-file`. >> -blame.markUnblamables:: >> +blame.markUnblamableLines:: >>       Mark lines that were changed by an ignored revision that we >> could not >>       attribute to another commit with a '*' in the output of >>       linkgit:git-blame[1]. >> > > That above is not typo fixing; that is correcting configuration variable > name. This issue in documentation of git-blame was introduced when the config option was added in commit 8934ac8c92 (blame: add config options for the output of ignored or unblamable lines, 2019-05-15). It first appeared in v6 of that series [1] where it was called blame.maskIgnoredUnblamables. In v7 [2] it got renamed to blame.markUnblamableLines. v7 of that series is the first time when incorrect blame.markUnblamables appears in Documentation/config/blame.txt. As far as I can tell, it's most probable that Barret Rhoden just missed one place when renaming this config option between v6 and v7. If we shouldn't refer to this patch as typofix, how about blame: fix name of blame.markUnblamableLines in docs or blame: correct name of config option in docs or config/blame.txt: correct name of blame.markUnblamableLines ? [1] https://lore.kernel.org/git/20190410162409.117264-5-brho@google.com/ [2] https://lore.kernel.org/git/20190515214503.77162-6-brho@google.com/ ``` ## Bagas Sanjaya, 2021-06-19 11:20 Subject: Re: [PATCH] blame: fix typo in documentation Message-ID: URL: https://gitlist.dev/e/e0199bd4-1585-061b-5dba-7da1232d9b43%40gmail.com In-Reply-To: <7cbbd59b-d5e3-4b96-a1ee-a242a7839028@gmail.com> ``` On 19/06/21 18.12, Andrei Rybak wrote: > If we shouldn't refer to this patch as typofix, how about > >     blame: fix name of blame.markUnblamableLines in docs > > or > >     blame: correct name of config option in docs > > or > >     config/blame.txt: correct name of blame.markUnblamableLines > > ? > I prefer the second, because I prefer not to reveal actual config name so that readers must see the whole patch to see the name. -- An old man doll... just what I always wanted! - Clara ``` ## Andrei Rybak, 2021-06-19 11:29 Subject: [PATCH v2] blame: correct name of config option in docs Message-ID: <20210619112912.76136-1-rybak.a.v@gmail.com> URL: https://gitlist.dev/e/20210619112912.76136-1-rybak.a.v%40gmail.com In-Reply-To: <20210618221104.42260-1-rybak.a.v@gmail.com> ``` As can be seen in files "Documentation/blame-options.txt" and "builtin/blame.c", the name of this configuration option is "blame.markUnblamableLines". Signed-off-by: Andrei Rybak --- Thanks to Bagas Sanjaya for review. Changes since v1: - tweaked commit message Range-diff: 1: e32c298ee8 ! 1: 6ea64765e7 blame: fix typo in documentation @@ Metadata Author: Andrei Rybak ## Commit message ## - blame: fix typo in documentation + blame: correct name of config option in docs As can be seen in files "Documentation/blame-options.txt" and - "builtin/blame.c", the name of this configuration variable is + "builtin/blame.c", the name of this configuration option is "blame.markUnblamableLines". Signed-off-by: Andrei Rybak Documentation/config/blame.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/config/blame.txt b/Documentation/config/blame.txt index 9468e8599c..4d047c1790 100644 --- a/Documentation/config/blame.txt +++ b/Documentation/config/blame.txt @@ -27,7 +27,7 @@ blame.ignoreRevsFile:: file names will reset the list of ignored revisions. This option will be handled before the command line option `--ignore-revs-file`. -blame.markUnblamables:: +blame.markUnblamableLines:: Mark lines that were changed by an ignored revision that we could not attribute to another commit with a '*' in the output of linkgit:git-blame[1]. -- 2.32.0 ``` ## Felipe Contreras, 2021-06-19 17:31 Subject: Re: [PATCH] blame: fix typo in documentation Message-ID: <60ce29d9144e9_cc2b1208f8@natae.notmuch> URL: https://gitlist.dev/e/60ce29d9144e9_cc2b1208f8%40natae.notmuch In-Reply-To: <8921ac50-e628-9a60-2a8d-1b8cc2a5a056@gmail.com> ``` Bagas Sanjaya wrote: > That above is not typo fixing; that is correcting configuration variable > name. > > PS: I have to download mbox of this thread and reply from it because I > didn't receive the thread on my Thunderbird, regardless of CCing Git ML. This is something I've noticed; I can always see mails on the archive, however, I don't receive them on my inbox until much later. -- Felipe Contreras ``` ## Bagas Sanjaya, 2021-06-20 09:37 Subject: Re: [PATCH v2] blame: correct name of config option in docs Message-ID: <744f5e3e-808e-3ea1-9f3a-892c3936dcbd@gmail.com> URL: https://gitlist.dev/e/744f5e3e-808e-3ea1-9f3a-892c3936dcbd%40gmail.com In-Reply-To: <20210619112912.76136-1-rybak.a.v@gmail.com> ``` On 19/06/21 18.29, Andrei Rybak wrote: > As can be seen in files "Documentation/blame-options.txt" and > "builtin/blame.c", the name of this configuration option is > "blame.markUnblamableLines". > > Signed-off-by: Andrei Rybak > --- > > Thanks to Bagas Sanjaya for review. Changes since v1: > > - tweaked commit message > > Range-diff: > > 1: e32c298ee8 ! 1: 6ea64765e7 blame: fix typo in documentation > @@ Metadata > Author: Andrei Rybak > > ## Commit message ## > - blame: fix typo in documentation > + blame: correct name of config option in docs > > As can be seen in files "Documentation/blame-options.txt" and > - "builtin/blame.c", the name of this configuration variable is > + "builtin/blame.c", the name of this configuration option is > "blame.markUnblamableLines". > > Signed-off-by: Andrei Rybak > > Documentation/config/blame.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/config/blame.txt b/Documentation/config/blame.txt > index 9468e8599c..4d047c1790 100644 > --- a/Documentation/config/blame.txt > +++ b/Documentation/config/blame.txt > @@ -27,7 +27,7 @@ blame.ignoreRevsFile:: > file names will reset the list of ignored revisions. This option will > be handled before the command line option `--ignore-revs-file`. > > -blame.markUnblamables:: > +blame.markUnblamableLines:: > Mark lines that were changed by an ignored revision that we could not > attribute to another commit with a '*' in the output of > linkgit:git-blame[1]. > Looks OK, thanks for contributing. Reviewed-by: Bagas Sanjaya -- An old man doll... just what I always wanted! - Clara ``` ## Barret Rhoden, 2021-06-21 16:57 Subject: Re: [PATCH v2] blame: correct name of config option in docs Message-ID: <662bf3a8-4690-0a32-275e-7298ccbb09c0@google.com> URL: https://gitlist.dev/e/662bf3a8-4690-0a32-275e-7298ccbb09c0%40google.com In-Reply-To: <744f5e3e-808e-3ea1-9f3a-892c3936dcbd@gmail.com> ``` On 6/20/21 5:37 AM, Bagas Sanjaya wrote: > On 19/06/21 18.29, Andrei Rybak wrote: >> As can be seen in files "Documentation/blame-options.txt" and >> "builtin/blame.c", the name of this configuration option is >> "blame.markUnblamableLines". >> >> Signed-off-by: Andrei Rybak > Looks OK, thanks for contributing. > > Reviewed-by: Bagas Sanjaya > thanks for the fix. =) ``` ## Andrei Rybak, 2021-06-25 19:38 Subject: [PATCH v3 0/3] Config option names typofixes Message-ID: <20210625193851.2233114-1-rybak.a.v@gmail.com> URL: https://gitlist.dev/e/20210625193851.2233114-1-rybak.a.v%40gmail.com In-Reply-To: <20210619112912.76136-1-rybak.a.v@gmail.com> ``` First patch in this series is the same as the v2 patch. Second patch fixes similar typos in mentions of config options in test messages. Third patch is just a fix for an unrelated typo I've stumbled upon. Andrei Rybak (3): blame: correct name of config option in docs t: fix typos in test messages git-worktree.txt: fix typo in example path Documentation/config/blame.txt | 2 +- Documentation/git-worktree.txt | 2 +- t/t4258-am-quoted-cr.sh | 2 +- t/t9001-send-email.sh | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) -- 2.32.0 ``` ## Andrei Rybak, 2021-06-25 19:38 Subject: [PATCH v3 1/3] blame: correct name of config option in docs Message-ID: <20210625193851.2233114-2-rybak.a.v@gmail.com> URL: https://gitlist.dev/e/20210625193851.2233114-2-rybak.a.v%40gmail.com In-Reply-To: <20210625193851.2233114-1-rybak.a.v@gmail.com> ``` As can be seen in files "Documentation/blame-options.txt" and "builtin/blame.c", the name of this configuration option is "blame.markUnblamableLines". Signed-off-by: Andrei Rybak Reviewed-by: Bagas Sanjaya --- Documentation/config/blame.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/config/blame.txt b/Documentation/config/blame.txt index 9468e8599c..4d047c1790 100644 --- a/Documentation/config/blame.txt +++ b/Documentation/config/blame.txt @@ -27,7 +27,7 @@ blame.ignoreRevsFile:: file names will reset the list of ignored revisions. This option will be handled before the command line option `--ignore-revs-file`. -blame.markUnblamables:: +blame.markUnblamableLines:: Mark lines that were changed by an ignored revision that we could not attribute to another commit with a '*' in the output of linkgit:git-blame[1]. -- 2.32.0 ``` ## Andrei Rybak, 2021-06-25 19:38 Subject: [PATCH v3 2/3] t: fix typos in test messages Message-ID: <20210625193851.2233114-3-rybak.a.v@gmail.com> URL: https://gitlist.dev/e/20210625193851.2233114-3-rybak.a.v%40gmail.com In-Reply-To: <20210625193851.2233114-1-rybak.a.v@gmail.com> ``` Both in t4258 and in t9001, the code of the tests following shows the proper name for the configuration variables. So use the correct names in the test messages as well. Signed-off-by: Andrei Rybak --- t/t4258-am-quoted-cr.sh | 2 +- t/t9001-send-email.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/t/t4258-am-quoted-cr.sh b/t/t4258-am-quoted-cr.sh index fb5071f914..201915b45a 100755 --- a/t/t4258-am-quoted-cr.sh +++ b/t/t4258-am-quoted-cr.sh @@ -26,7 +26,7 @@ test_expect_success 'am --quoted-cr=strip' ' git diff --exit-code HEAD two ' -test_expect_success 'am with config mailinfo.quotecr=strip' ' +test_expect_success 'am with config mailinfo.quotedCr=strip' ' test_might_fail git am --abort && git reset --hard one && test_config mailinfo.quotedCr strip && diff --git a/t/t9001-send-email.sh b/t/t9001-send-email.sh index c66d9190de..9ec7d75f0f 100755 --- a/t/t9001-send-email.sh +++ b/t/t9001-send-email.sh @@ -1839,7 +1839,7 @@ test_expect_success $PREREQ 'sendemail.aliasfiletype=mailrc' ' grep "^!somebody@example\.org!$" commandline1 ' -test_expect_success $PREREQ 'sendemail.aliasfile=~/.mailrc' ' +test_expect_success $PREREQ 'sendemail.aliasesfile=~/.mailrc' ' clean_fake_sendmail && echo "alias sbd someone@example.org" >"$HOME/.mailrc" && git config --replace-all sendemail.aliasesfile "~/.mailrc" && -- 2.32.0 ``` ## Andrei Rybak, 2021-06-25 19:38 Subject: [PATCH v3 3/3] git-worktree.txt: fix typo in example path Message-ID: <20210625193851.2233114-4-rybak.a.v@gmail.com> URL: https://gitlist.dev/e/20210625193851.2233114-4-rybak.a.v%40gmail.com In-Reply-To: <20210625193851.2233114-1-rybak.a.v@gmail.com> ``` Signed-off-by: Andrei Rybak --- Documentation/git-worktree.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt index f1bb1fa5f5..66e67e6cbf 100644 --- a/Documentation/git-worktree.txt +++ b/Documentation/git-worktree.txt @@ -387,7 +387,7 @@ These annotations are: ------------ $ git worktree list /path/to/linked-worktree abcd1234 [master] -/path/to/locked-worktreee acbd5678 (brancha) locked +/path/to/locked-worktree acbd5678 (brancha) locked /path/to/prunable-worktree 5678abc (detached HEAD) prunable ------------ -- 2.32.0 ``` ## Carlo Marcelo Arenas Belón, 2021-06-26 06:58 Subject: Re: [PATCH v3 3/3] git-worktree.txt: fix typo in example path Message-ID: URL: https://gitlist.dev/e/YNbQGoMP%2BwYZS0CA%40carlos-mbp.lan In-Reply-To: <20210625193851.2233114-4-rybak.a.v@gmail.com> ``` not sure if this patch really belongs in this specific patchset, but it might be worth also fixing the same typo in grep as shown by : --- >8 --- Subject: grep: fix worktree mis spelling 1d1729caeb (grep: replace grep_read_mutex by internal obj read lock, 2020-01-15) adds it as part of a comment fix it to the right spelling without the extra trailing 'e'. diff --git a/grep.c b/grep.c index 8f91af1cb0..f40c734565 100644 --- a/grep.c +++ b/grep.c @@ -1510,7 +1510,7 @@ static int fill_textconv_grep(struct repository *r, * * TODO: allowing text conversion to run in parallel with object * reading operations might increase performance in the multithreaded - * non-worktreee git-grep with --textconv. + * non-worktree git-grep with --textconv. */ obj_read_lock(); size = fill_textconv(r, driver, df, &buf); Signed-off-by: Carlo Marcelo Arenas Belón ``` ## Andrei Rybak, 2021-06-26 10:07 Subject: Re: [PATCH v3 3/3] git-worktree.txt: fix typo in example path Message-ID: <8da4cb97-eb46-1ce5-ee74-fb1286d230aa@gmail.com> URL: https://gitlist.dev/e/8da4cb97-eb46-1ce5-ee74-fb1286d230aa%40gmail.com In-Reply-To: ``` On 26/06/2021 08:58, Carlo Marcelo Arenas Belón wrote: > not sure if this patch really belongs in this specific patchset Yes, third patch is unrelated to the first two. >, but it > might be worth also fixing the same typo in grep as shown by : > > --- >8 --- > Subject: grep: fix worktree mis spelling s/mis spelling/misspelling/ > > 1d1729caeb (grep: replace grep_read_mutex by internal obj read lock, > 2020-01-15) adds it as part of a comment > > fix it to the right spelling without the extra trailing 'e'. > > diff --git a/grep.c b/grep.c > index 8f91af1cb0..f40c734565 100644 > --- a/grep.c > +++ b/grep.c > @@ -1510,7 +1510,7 @@ static int fill_textconv_grep(struct repository *r, > * > * TODO: allowing text conversion to run in parallel with object > * reading operations might increase performance in the multithreaded > - * non-worktreee git-grep with --textconv. > + * non-worktree git-grep with --textconv. I deliberately skipped this typo, because it is in a TODO comment, which I thought isn't worth fixing. I probably should have mentioned that in the patch I've sent. > */ > obj_read_lock(); > size = fill_textconv(r, driver, df, &buf); > > Signed-off-by: Carlo Marcelo Arenas Belón > ``` ## Bagas Sanjaya, 2021-06-26 11:50 Subject: Re: [PATCH v3 0/3] Config option names typofixes Message-ID: <94a4dc6e-a8e7-d6d1-33c1-5a0dcfa9a4ca@gmail.com> URL: https://gitlist.dev/e/94a4dc6e-a8e7-d6d1-33c1-5a0dcfa9a4ca%40gmail.com In-Reply-To: <20210625193851.2233114-1-rybak.a.v@gmail.com> ``` On 26/06/21 02.38, Andrei Rybak wrote: > First patch in this series is the same as the v2 patch. Second patch fixes > similar typos in mentions of config options in test messages. Third patch is > just a fix for an unrelated typo I've stumbled upon. > > Andrei Rybak (3): > blame: correct name of config option in docs > t: fix typos in test messages > git-worktree.txt: fix typo in example path I suggest that the third patch should be on separate single patch, as it is unrelated to two other patches that correct config option names. Thanks. -- An old man doll... just what I always wanted! - Clara ``` ## Junio C Hamano, 2021-06-29 01:12 Subject: Re: [PATCH v3 3/3] git-worktree.txt: fix typo in example path Message-ID: URL: https://gitlist.dev/e/xmqq5yxx4gol.fsf%40gitster.g In-Reply-To: <8da4cb97-eb46-1ce5-ee74-fb1286d230aa@gmail.com> ``` Andrei Rybak writes: > On 26/06/2021 08:58, Carlo Marcelo Arenas Belón wrote: >> not sure if this patch really belongs in this specific patchset > > Yes, third patch is unrelated to the first two. > >>, but it >> might be worth also fixing the same typo in grep as shown by : >> --- >8 --- >> Subject: grep: fix worktree mis spelling > > s/mis spelling/misspelling/ > >> 1d1729caeb (grep: replace grep_read_mutex by internal obj read lock, >> 2020-01-15) adds it as part of a comment >> fix it to the right spelling without the extra trailing 'e'. >> diff --git a/grep.c b/grep.c >> index 8f91af1cb0..f40c734565 100644 >> --- a/grep.c >> +++ b/grep.c >> @@ -1510,7 +1510,7 @@ static int fill_textconv_grep(struct repository *r, >> * >> * TODO: allowing text conversion to run in parallel with object >> * reading operations might increase performance in the multithreaded >> - * non-worktreee git-grep with --textconv. >> + * non-worktree git-grep with --textconv. > > I deliberately skipped this typo, because it is in a TODO comment, which > I thought isn't worth fixing. I probably should have mentioned that in > the patch I've sent. All sound sensible. Will queue these three patches as-is. Thanks. ```