Skip to contentSkip to conversation

blame: fix typo in documentation

PATCH In review Andrei Rybak 6 participants 16 messages Jun 18, 2021 – Jun 29, 2021 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 blame: fix typo in documentation

As can be seen in files "Documentation/blame-options.txt" and "builtin/blame.c", the name of this configuration variable is "blame.markUnblamableLines".

---
 Documentation/config/blame.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/blame.txt +1 -1
index 9468e8599c..4d047c1790 100644
@@ -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].
Signature · 1 line
2.32.0
#1 lore raw

Hi,

Quoted 15 lines · Andrei Rybak

As can be seen in files "Documentation/blame-options.txt" and "builtin/blame.c", the name of this configuration variable is "blame.markUnblamableLines".

---
  Documentation/config/blame.txt | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/blame.txt +0 -0
index 9468e8599c..4d047c1790 100644

Documentation/config/blame.txt blame.ignoreRevsFile:: · line 33

Quoted 8 lines
Documentation/config/blame.txt +1 -1
@@ -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.

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#2 lore raw
Quoted 10 lines · Bagas Sanjaya
Quoted 9 lines · Andrei Rybak

As can be seen in files "Documentation/blame-options.txt" and "builtin/blame.c", the name of this configuration variable is "blame.markUnblamableLines".

---
  Documentation/config/blame.txt | 2 +-

  1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 15 lines
Quoted 9 lines
Documentation/config/blame.txt +0 -0
index 9468e8599c..4d047c1790 100644
@@ -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.

Documentation/config/blame.txt +1 -1
-blame.markUnblamables::
+blame.markUnblamableLines::
Quoted 4 lines

      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/[email protected]/
[2] https://lore.kernel.org/git/[email protected]/

#3 lore raw
Quoted 6 lines · Andrei Rybak

If we shouldn't refer to this patch as typofix, how about

    blame: fix name of blame.markUnblamableLines in docs

or

Quoted 8 lines

    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.

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#4 lore raw
In reply to Bagas Sanjaya
Quoted 5 lines · Bagas Sanjaya

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.

Signature · 1 line
Felipe Contreras
#5 lore raw

PATCH v2 1/1 blame: correct name of config option in docs

In reply to Andrei Rybak

As can be seen in files "Documentation/blame-options.txt" and "builtin/blame.c", the name of this configuration option is "blame.markUnblamableLines".

---

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 <[email protected]>

## 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".

 Documentation/config/blame.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/blame.txt +1 -1
index 9468e8599c..4d047c1790 100644
@@ -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].
Signature · 1 line
2.32.0
Reviewed-by on v2 1/1
#6 lore raw

Re: [PATCH v2] blame: correct name of config option in docs

Quoted 37 lines · Andrei Rybak

As can be seen in files "Documentation/blame-options.txt" and "builtin/blame.c", the name of this configuration option is "blame.markUnblamableLines".

---

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 <[email protected]>

## 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".

  Documentation/config/blame.txt | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/blame.txt +0 -0
index 9468e8599c..4d047c1790 100644

Documentation/config/blame.txt blame.ignoreRevsFile:: · line 33

Quoted 8 lines
Documentation/config/blame.txt +1 -1
@@ -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.

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#7 lore raw

Re: [PATCH v2] blame: correct name of config option in docs

Quoted 10 lines · Bagas Sanjaya
Quoted 5 lines · Andrei Rybak

As can be seen in files "Documentation/blame-options.txt" and "builtin/blame.c", the name of this configuration option is "blame.markUnblamableLines".

Looks OK, thanks for contributing.

thanks for the fix. =)

#8 lore raw

v3 cover Config option names typofixes

In reply to Andrei Rybak

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(-)
Signature · 1 line
2.32.0
#9 lore raw

PATCH v3 1/3 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 option is "blame.markUnblamableLines".

---
 Documentation/config/blame.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/blame.txt +1 -1
index 9468e8599c..4d047c1790 100644
@@ -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].
Signature · 1 line
2.32.0
#10 lore raw

PATCH v3 2/3 t: fix typos in test messages

In reply to Andrei Rybak

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.

---
 t/t4258-am-quoted-cr.sh | 2 +-
 t/t9001-send-email.sh   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
t/t4258-am-quoted-cr.sh +1 -1
index fb5071f914..201915b45a 100755
@@ -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 &&
t/t9001-send-email.sh +1 -1
index c66d9190de..9ec7d75f0f 100755
@@ -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  [email protected]" >"$HOME/.mailrc" &&
 	git config --replace-all sendemail.aliasesfile "~/.mailrc" &&
Signature · 1 line
2.32.0
#11 lore raw

PATCH v3 3/3 git-worktree.txt: fix typo in example path

In reply to Andrei Rybak
---
 Documentation/git-worktree.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-worktree.txt +1 -1
index f1bb1fa5f5..66e67e6cbf 100644
@@ -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
 ------------
 
Signature · 1 line
2.32.0
#12 lore raw

Re: [PATCH v3 3/3] git-worktree.txt: fix typo in example path

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'.

grep.c +1 -1
index 8f91af1cb0..f40c734565 100644
@@ -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);
#13 lore raw

Re: [PATCH v3 3/3] git-worktree.txt: fix typo in example path

Quoted 1 line · Carlo Marcelo Arenas Belón

not sure if this patch really belongs in this specific patchset

Yes, third patch is unrelated to the first two.

Quoted 5 lines

, 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/

Quoted 11 lines

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'.

grep.c +0 -0
index 8f91af1cb0..f40c734565 100644

grep.c static int fill_textconv_grep(struct repository *r, · line 1513

Quoted 5 lines
grep.c +1 -1
@@ -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.

Quoted 6 lines
grep.c +0 -0
  	 */
  	obj_read_lock();
  	size = fill_textconv(r, driver, df, &buf);
#14 lore raw

Re: [PATCH v3 3/3] git-worktree.txt: fix typo in example path

Quoted 21 lines · Andrei Rybak
Quoted 1 line · Carlo Marcelo Arenas Belón

not sure if this patch really belongs in this specific patchset

Yes, third patch is unrelated to the first two.

Quoted 4 lines

, 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/

Quoted 9 lines

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'.

grep.c +0 -0
index 8f91af1cb0..f40c734565 100644
@@ -1510,7 +1510,7 @@ static int fill_textconv_grep(struct repository *r,
  	 *
Quoted 8 lines

grep.c static int fill_textconv_grep(struct repository *r, · line 1513

Quoted 4 lines
grep.c +1 -1
  	 * 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.

#15 lore raw

Re: [PATCH v3 0/3] Config option names typofixes

In reply to Andrei Rybak
Quoted 8 lines · Andrei Rybak

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.

Signature · 1 line
An old man doll... just what I always wanted! - Clara