doc: fix a typo in gitcore-tutorial.txt
cover doc: fix a typo in gitcore-tutorial.txt
Fix a typo.
Heba Waly (1):
doc: fix a typo in gitcore-tutorial.txt
Documentation/gitcore-tutorial.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
base-commit: 8679ef24ed64018bb62170c43ce73e0261c0600a
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-515%2FHebaWaly%2Fgitcore_tutorial_typo-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-515/HebaWaly/gitcore_tutorial_typo-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/515
Signature · 1 line
gitgitgadget
PATCH 1/1 doc: fix a typo in gitcore-tutorial.txt
From: Heba Waly <[email protected]>
--- Documentation/gitcore-tutorial.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/gitcore-tutorial.txt +1 -1
@@ -751,7 +751,7 @@ to it. ================================================ If you make the decision to start your new branch at some other point in the history than the current `HEAD`, you can do so by -just telling 'git checkout' what the base of the checkout would be. +just telling 'git switch' what the base of the checkout would be. In other words, if you have an earlier tag or branch, you'd just do ------------
Signature · 1 line
gitgitgadget
Documentation/gitcore-tutorial.txt to it. · line 754
Quoted 11 lines · Heba Waly via GitGitGadget
doc: fix a typo in gitcore-tutorial.txt
Signed-off-by Heba Waly <[email protected]>---
Documentation/gitcore-tutorial.txt +1
-1@@ -751,7 +751,7 @@ to it. ================================================ If you make the decision to start your new branch at some other point in the history than the current `HEAD`, you can do so by -just telling 'git checkout' what the base of the checkout would be. +just telling 'git switch' what the base of the checkout would be.
Calling this change a "typo fix" confuses reviewers since it's clearly not a mere typographical error. It looks instead as if you are recommending git-switch over git-checkout, so a reader would expect the commit message to justify that change rather than merely calling it a "typo fix". However, digging deeper, one finds that this is actually fixing an oversight from an earlier change which already updated this file to prefer git-switch over git-checkout.
To save reviewers the time and effort of having to figure all this out, use the commit message to explain the situation. For example, you might say:
doc/gitcore-tutorial: fix prose to match example command
In 328c6cb853 (doc: promote "git switch", 2019-03-29), an example was changed to use "git switch" rather than "git checkout" but an instance of "git checkout" in the explanatory text preceding the example was overlooked. Fix this oversight.
Quoted 10 lines · Eric Sunshine
To save reviewers the time and effort of having to figure all this out, use the commit message to explain the situation. For example, you might say:
doc/gitcore-tutorial: fix prose to match example command
In
328c6cb853(doc: promote "git switch", 2019-03-29), an example was changed to use "git switch" rather than "git checkout" but an instance of "git checkout" in the explanatory text preceding the example was overlooked. Fix this oversight.
Thanks for a ncie educational session ;-)
Quoted 14 lines · Eric Sunshine
Calling this change a "typo fix" confuses reviewers since it's clearly not a mere typographical error. It looks instead as if you are recommending git-switch over git-checkout, so a reader would expect the commit message to justify that change rather than merely calling it a "typo fix". However, digging deeper, one finds that this is actually fixing an oversight from an earlier change which already updated this file to prefer git-switch over git-checkout.
To save reviewers the time and effort of having to figure all this out, use the commit message to explain the situation. For example, you might say:
Quoted 6 lines
doc/gitcore-tutorial: fix prose to match example command
In
328c6cb853(doc: promote "git switch", 2019-03-29), an example was changed to use "git switch" rather than "git checkout" but an instance of "git checkout" in the explanatory text preceding the example was overlooked. Fix this oversight.
Looks like I overlooked this commit for its simplicity, I thought it was too simple and self explanatory. I agree with you though.
Thanks,
Heba
v2 cover doc/gitcore-tutorial: fix prose to match example command
In reply to Heba Waly via GitGitGadgetIn 328c6cb853 (doc: promote "git switch", 2019-03-29), an example was changed to use "git switch" rather than "git checkout" but an instance of "git checkout" in the explanatory text preceding the example was overlooked. Fix this oversight.
Heba Waly (1):
doc/gitcore-tutorial: fix prose to match example command
Documentation/gitcore-tutorial.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
base-commit: 8679ef24ed64018bb62170c43ce73e0261c0600a
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-515%2FHebaWaly%2Fgitcore_tutorial_typo-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-515/HebaWaly/gitcore_tutorial_typo-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/515
Range-diff vs v1:
1: ee8636e0ed ! 1: 0c75cd8f97 doc: fix a typo in gitcore-tutorial.txt
@@ -1,6 +1,11 @@
Author: Heba Waly <[email protected]>
- doc: fix a typo in gitcore-tutorial.txt
+ doc/gitcore-tutorial: fix prose to match example command
+
+ In 328c6cb853 (doc: promote "git switch", 2019-03-29), an example
+ was changed to use "git switch" rather than "git checkout" but an
+ instance of "git checkout" in the explanatory text preceding the
+ example was overlooked. Fix this oversight.
Signature · 1 line
gitgitgadget
PATCH v2 1/1 doc/gitcore-tutorial: fix prose to match example command
From: Heba Waly <[email protected]>
In 328c6cb853 (doc: promote "git switch", 2019-03-29), an example was changed to use "git switch" rather than "git checkout" but an instance of "git checkout" in the explanatory text preceding the example was overlooked. Fix this oversight.
--- Documentation/gitcore-tutorial.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/gitcore-tutorial.txt +1 -1
@@ -751,7 +751,7 @@ to it. ================================================ If you make the decision to start your new branch at some other point in the history than the current `HEAD`, you can do so by -just telling 'git checkout' what the base of the checkout would be. +just telling 'git switch' what the base of the checkout would be. In other words, if you have an earlier tag or branch, you'd just do ------------
Signature · 1 line
gitgitgadget
Re: [PATCH v2 1/1] doc/gitcore-tutorial: fix prose to match example command
Quoted 17 lines · Heba Waly via GitGitGadget
From: Heba Waly <[email protected]>
In
328c6cb853(doc: promote "git switch", 2019-03-29), an example was changed to use "git switch" rather than "git checkout" but an instance of "git checkout" in the explanatory text preceding the example was overlooked. Fix this oversight.Signed-off-by Heba Waly <[email protected]>--- Documentation/gitcore-tutorial.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/gitcore-tutorial.txt +0
-0
Documentation/gitcore-tutorial.txt to it. · line 757
Quoted 8 lines
Documentation/gitcore-tutorial.txt +1
-1@@ -751,7 +751,7 @@ to it. ================================================ If you make the decision to start your new branch at some other point in the history than the current `HEAD`, you can do so by -just telling 'git checkout' what the base of the checkout would be. +just telling 'git switch' what the base of the checkout would be. In other words, if you have an earlier tag or branch, you'd just do ------------
Thanks. The part before this paragraph does illustrate the use of "switch", and we should talk about that command here, too.