Git development
 help / color / mirror / Atom feed
* [PATCH] doc: fix AsciiDoc syntax
@ 2026-11-20 17:12 Ophir Bleicher via GitGitGadget
  2026-11-20 17:54 ` Ben Knoble
  2026-11-20 18:35 ` [PATCH v2] " Ophir Bleicher via GitGitGadget
  0 siblings, 2 replies; 5+ messages in thread
From: Ophir Bleicher via GitGitGadget @ 2026-11-20 17:12 UTC (permalink / raw)
  To: git; +Cc: Ophir Bleicher, Ophir Bleicher

From: Ophir Bleicher <ophirble@gmail.com>

The Documentation/MyFirstContribution.adoc file accidentally used
Markdown syntax for a link:

[here](https://gitgitgadget.github.io/#...)

Fixed it to use AsciiDoc:

https://gitgitgadget.github.io/#...[here]

Signed-off-by: Ophir Bleicher <ophirble@gmail.com>
---
    doc: fix AsciiDoc syntax

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2496%2FOphirBleicher%2Fpatch-3-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2496/OphirBleicher/patch-3-v1
Pull-Request: https://github.com/git/git/pull/2496

 Documentation/MyFirstContribution.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index c58253fd54..3b531b24fa 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -931,7 +931,7 @@ either with the "New pull request" button or the convenient "Compare & pull
 request" button that may appear with the name of your newly pushed branch.
 
 The differences between using `gitgitgadget/git` and `git/git` as your base can
-be found [here](https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror)
+be found https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror[here]
 
 Review the PR's title and description, as they're used by GitGitGadget
 respectively as the subject and body of the cover letter for your change. Refer

base-commit: f7de81456940dd6f3274e461149bba12965de609
-- 
gitgitgadget

^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH] doc: fix AsciiDoc syntax
  2026-11-20 17:12 [PATCH] doc: fix AsciiDoc syntax Ophir Bleicher via GitGitGadget
@ 2026-11-20 17:54 ` Ben Knoble
  2026-11-20 18:08   ` Junio C Hamano
  2026-11-20 18:35 ` [PATCH v2] " Ophir Bleicher via GitGitGadget
  1 sibling, 1 reply; 5+ messages in thread
From: Ben Knoble @ 2026-11-20 17:54 UTC (permalink / raw)
  To: Ophir Bleicher via GitGitGadget; +Cc: git, Ophir Bleicher


> Le 20 nov. 2026 à 12:31, Ophir Bleicher via GitGitGadget <gitgitgadget@gmail.com> a écrit :
> 
> From: Ophir Bleicher <ophirble@gmail.com>
> 
> The Documentation/MyFirstContribution.adoc file accidentally used
> Markdown syntax for a link:
> 
> [here](https://gitgitgadget.github.io/#...)
> 
> Fixed it to use AsciiDoc:
> 
> https://gitgitgadget.github.io/#...[here]

Good catch.

While we’re at it, « here » is generally discouraged as link text.
It’s not particularly accessible for screen-readers, for example.

> Signed-off-by: Ophir Bleicher <ophirble@gmail.com>
> ---
>    doc: fix AsciiDoc syntax
> 
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2496%2FOphirBleicher%2Fpatch-3-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2496/OphirBleicher/patch-3-v1
> Pull-Request: https://github.com/git/git/pull/2496
> 
> Documentation/MyFirstContribution.adoc | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
> index c58253fd54..3b531b24fa 100644
> --- a/Documentation/MyFirstContribution.adoc
> +++ b/Documentation/MyFirstContribution.adoc
> @@ -931,7 +931,7 @@ either with the "New pull request" button or the convenient "Compare & pull
> request" button that may appear with the name of your newly pushed branch.
> 
> The differences between using `gitgitgadget/git` and `git/git` as your base can
> -be found [here](https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror)
> +be found https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror[here]

So perhaps we could reword this to something like

    Further [differences between …] are described online.

with the brackets marking the link text?

> Review the PR's title and description, as they're used by GitGitGadget
> respectively as the subject and body of the cover letter for your change. Refer
> 
> base-commit: f7de81456940dd6f3274e461149bba12965de609
> --
> gitgitgadget
> 

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] doc: fix AsciiDoc syntax
  2026-11-20 17:54 ` Ben Knoble
@ 2026-11-20 18:08   ` Junio C Hamano
  0 siblings, 0 replies; 5+ messages in thread
From: Junio C Hamano @ 2026-11-20 18:08 UTC (permalink / raw)
  To: Ben Knoble; +Cc: Ophir Bleicher via GitGitGadget, git, Ophir Bleicher

Ben Knoble <ben.knoble@gmail.com> writes:

>> Fixed it to use AsciiDoc:
>> 
>> https://gitgitgadget.github.io/#...[here]
>
> Good catch.
>
> While we’re at it, « here » is generally discouraged as link text.
> It’s not particularly accessible for screen-readers, for example.

I also thought that it was a funny but understandable mistake we
made, given how prevalent Markdown is these days, but didn't think
of the need to improve the link text.

Great suggestion.

>> The differences between using `gitgitgadget/git` and `git/git` as your base can
>> -be found [here](https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror)
>> +be found https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror[here]
>
> So perhaps we could reword this to something like
>
>     Further [differences between …] are described online.
>
> with the brackets marking the link text?

Sounds good.

Thanks.

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [PATCH v2] doc: fix AsciiDoc syntax
  2026-11-20 17:12 [PATCH] doc: fix AsciiDoc syntax Ophir Bleicher via GitGitGadget
  2026-11-20 17:54 ` Ben Knoble
@ 2026-11-20 18:35 ` Ophir Bleicher via GitGitGadget
  2026-11-20 19:03   ` Junio C Hamano
  1 sibling, 1 reply; 5+ messages in thread
From: Ophir Bleicher via GitGitGadget @ 2026-11-20 18:35 UTC (permalink / raw)
  To: git; +Cc: Ophir Bleicher, Ophir Bleicher

From: Ophir Bleicher <ophirble@gmail.com>

The Documentation/MyFirstContribution.adoc file accidentally used
Markdown syntax for a link:

[here](https://gitgitgadget.github.io/#...)

Fixed it to use AsciiDoc:

https://gitgitgadget.github.io/#...[here]

Signed-off-by: Ophir Bleicher <ophirble@gmail.com>
---
    doc: fix AsciiDoc syntax
    
    Difference from v1:
    
     * Change link text

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2496%2FOphirBleicher%2Fpatch-3-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2496/OphirBleicher/patch-3-v2
Pull-Request: https://github.com/git/git/pull/2496

Range-diff vs v1:

 1:  748ac69283 ! 1:  cf26060e59 doc: fix AsciiDoc syntax
     @@ Documentation/MyFirstContribution.adoc: either with the "New pull request" butto
       
       The differences between using `gitgitgadget/git` and `git/git` as your base can
      -be found [here](https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror)
     -+be found https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror[here]
     ++be found https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror[on GitGitGadget's official documentation.]
       
       Review the PR's title and description, as they're used by GitGitGadget
       respectively as the subject and body of the cover letter for your change. Refer


 Documentation/MyFirstContribution.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index c58253fd54..73dab5f7c9 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -931,7 +931,7 @@ either with the "New pull request" button or the convenient "Compare & pull
 request" button that may appear with the name of your newly pushed branch.
 
 The differences between using `gitgitgadget/git` and `git/git` as your base can
-be found [here](https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror)
+be found https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror[on GitGitGadget's official documentation.]
 
 Review the PR's title and description, as they're used by GitGitGadget
 respectively as the subject and body of the cover letter for your change. Refer

base-commit: f7de81456940dd6f3274e461149bba12965de609
-- 
gitgitgadget

^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH v2] doc: fix AsciiDoc syntax
  2026-11-20 18:35 ` [PATCH v2] " Ophir Bleicher via GitGitGadget
@ 2026-11-20 19:03   ` Junio C Hamano
  0 siblings, 0 replies; 5+ messages in thread
From: Junio C Hamano @ 2026-11-20 19:03 UTC (permalink / raw)
  To: Ophir Bleicher via GitGitGadget; +Cc: git, Ophir Bleicher

"Ophir Bleicher via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Ophir Bleicher <ophirble@gmail.com>
>
> The Documentation/MyFirstContribution.adoc file accidentally used
> Markdown syntax for a link:
>
> [here](https://gitgitgadget.github.io/#...)
>
> Fixed it to use AsciiDoc:
>
> https://gitgitgadget.github.io/#...[here]
>
> Signed-off-by: Ophir Bleicher <ophirble@gmail.com>
> ---

The exact same tense and mood suggestion applies to this commit
message, too.  "uses" and "Fix".  I can locally tweak them while
queuing, so no need to resend if you are OK with it.

>     doc: fix AsciiDoc syntax
>     
>     Difference from v1:
>     
>      * Change link text
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2496%2FOphirBleicher%2Fpatch-3-v2
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2496/OphirBleicher/patch-3-v2
> Pull-Request: https://github.com/git/git/pull/2496
>
> Range-diff vs v1:
>
>  1:  748ac69283 ! 1:  cf26060e59 doc: fix AsciiDoc syntax
>      @@ Documentation/MyFirstContribution.adoc: either with the "New pull request" butto
>        
>        The differences between using `gitgitgadget/git` and `git/git` as your base can
>       -be found [here](https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror)
>      -+be found https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror[here]
>      ++be found https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror[on GitGitGadget's official documentation.]
>        
>        Review the PR's title and description, as they're used by GitGitGadget
>        respectively as the subject and body of the cover letter for your change. Refer
>
>
>  Documentation/MyFirstContribution.adoc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
> index c58253fd54..73dab5f7c9 100644
> --- a/Documentation/MyFirstContribution.adoc
> +++ b/Documentation/MyFirstContribution.adoc
> @@ -931,7 +931,7 @@ either with the "New pull request" button or the convenient "Compare & pull
>  request" button that may appear with the name of your newly pushed branch.
>  
>  The differences between using `gitgitgadget/git` and `git/git` as your base can
> -be found [here](https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror)
> +be found https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror[on GitGitGadget's official documentation.]
>  
>  Review the PR's title and description, as they're used by GitGitGadget
>  respectively as the subject and body of the cover letter for your change. Refer
>
> base-commit: f7de81456940dd6f3274e461149bba12965de609

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2026-11-20 19:03 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-20 17:12 [PATCH] doc: fix AsciiDoc syntax Ophir Bleicher via GitGitGadget
2026-11-20 17:54 ` Ben Knoble
2026-11-20 18:08   ` Junio C Hamano
2026-11-20 18:35 ` [PATCH v2] " Ophir Bleicher via GitGitGadget
2026-11-20 19:03   ` Junio C Hamano

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox