threads / patch / 52578

patch[Outreachy] doc: fix a typo in gitcore-tutorial.txt

Subject: [PATCH 0/1] [Outreachy] doc: fix a typo in gitcore-tutorial.txt

## tl;dr

8 messages between Jan 7, 2020 and Jan 8, 2020. Diffs are folded; open one to read it.

replies: 7people: 3as markdown or json

Heba Waly via GitGitGadget· Jan 7, 2020, 10:05 UTC · lore
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
-- 
gitgitgadget
Heba Waly via GitGitGadget· Jan 7, 2020, 10:05 UTC · re: Heba Waly via GitGitGadget · lore

[PATCH 1/1] doc: fix a typo in gitcore-tutorial.txt

From: Heba Waly <heba.waly@gmail.com>
Signed-off-by: Heba Waly <heba.waly@gmail.com>
---
 Documentation/gitcore-tutorial.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/gitcore-tutorial.txt +1 −1
diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
index f880d21dfb..c0b95256cc 100644
--- a/Documentation/gitcore-tutorial.txt
+++ b/Documentation/gitcore-tutorial.txt
@@ -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
 
 ------------

-- 
gitgitgadget
Eric Sunshine· Jan 7, 2020, 11:35 UTC · re: Heba Waly via GitGitGadget · lore

Re: [PATCH 1/1] doc: fix a typo in gitcore-tutorial.txt

On Tue, Jan 7, 2020 at 5:06 AM Heba Waly via GitGitGadget <gitgitgadget@gmail.com> wrote:

Show 11 quoted lines
> doc: fix a typo in gitcore-tutorial.txt
>
> Signed-off-by: Heba Waly <heba.waly@gmail.com>
> ---
> diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
> @@ -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.
Junio C Hamano· Jan 7, 2020, 19:58 UTC · re: Eric Sunshine · lore

Re: [PATCH 1/1] doc: fix a typo in gitcore-tutorial.txt

Eric Sunshine <sunshine@sunshineco.com> writes:
Show 10 quoted lines
> 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 ;-)
Heba Waly· Jan 8, 2020, 00:09 UTC · re: Eric Sunshine · lore

Re: [PATCH 1/1] doc: fix a typo in gitcore-tutorial.txt

On Wed, Jan 8, 2020 at 12:35 AM Eric Sunshine <sunshine@sunshineco.com> wrote:
Show 20 quoted lines
>
>
> 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.

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

Heba Waly via GitGitGadget· Jan 8, 2020, 00:31 UTC · re: Heba Waly via GitGitGadget · lore

[PATCH v2 0/1] [Outreachy] 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.

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 <heba.waly@gmail.com>
      
     -    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.
      
          Signed-off-by: Heba Waly <heba.waly@gmail.com>
      
-- 
gitgitgadget
Heba Waly via GitGitGadget· Jan 8, 2020, 00:31 UTC · re: Heba Waly via GitGitGadget · lore

[PATCH v2 1/1] doc/gitcore-tutorial: fix prose to match example command

From: Heba Waly <heba.waly@gmail.com>

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 <heba.waly@gmail.com>
---
 Documentation/gitcore-tutorial.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/gitcore-tutorial.txt +1 −1
diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
index f880d21dfb..c0b95256cc 100644
--- a/Documentation/gitcore-tutorial.txt
+++ b/Documentation/gitcore-tutorial.txt
@@ -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
 
 ------------

-- 
gitgitgadget
Junio C Hamano· Jan 8, 2020, 16:57 UTC · re: Heba Waly via GitGitGadget · lore

Re: [PATCH v2 1/1] doc/gitcore-tutorial: fix prose to match example command

"Heba Waly via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 25 quoted lines
> From: Heba Waly <heba.waly@gmail.com>
>
> 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 <heba.waly@gmail.com>
> ---
>  Documentation/gitcore-tutorial.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
> index f880d21dfb..c0b95256cc 100644
> --- a/Documentation/gitcore-tutorial.txt
> +++ b/Documentation/gitcore-tutorial.txt
> @@ -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.

← back to recent threads