[PATCH] Documentation: fix linkgit reference

[PATCH] Documentation: fix linkgit reference

[Yehezkel Bernat via GitGitGadget]

From: Yehezkel Bernat <yehezkelshb@gmail.com>

In git-replay documentation, linkgit to git-rev-parse is missing the man
section which breaks its rendering

Add section number as done in other references to this command

Signed-off-by: Yehezkel Bernat <YehezkelShB@gmail.com>
---
    Documentation: fix linkgit reference

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1706%2FYehezkelShB%2Fyb%2Ffix-linkgit-reference-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1706/YehezkelShB/yb/fix-linkgit-reference-v1
Pull-Request: https://github.com/git/git/pull/1706

 Documentation/git-replay.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-replay.txt b/Documentation/git-replay.txt
index f6c269c62d5..8f3300c683a 100644
--- a/Documentation/git-replay.txt
+++ b/Documentation/git-replay.txt
@@ -46,7 +46,7 @@ the new commits (in other words, this mimics a cherry-pick operation).
 	Range of commits to replay. More than one <revision-range> can
 	be passed, but in `--advance <branch>` mode, they should have
 	a single tip, so that it's clear where <branch> should point
-	to. See "Specifying Ranges" in linkgit:git-rev-parse and the
+	to. See "Specifying Ranges" in linkgit:git-rev-parse[1] and the
 	"Commit Limiting" options below.
 
 include::rev-list-options.txt[]

base-commit: 8f7582d995682f785e80e344197cc715e6bc7d8e
-- 
gitgitgadget

Re: [PATCH] Documentation: fix linkgit reference

[Patrick Steinhardt]

[-- Attachment #1: Type: text/plain, Size: 1724 bytes --]

On Sun, Apr 14, 2024 at 10:08:02PM +0000, Yehezkel Bernat via GitGitGadget wrote:
> From: Yehezkel Bernat <yehezkelshb@gmail.com>
> 
> In git-replay documentation, linkgit to git-rev-parse is missing the man
> section which breaks its rendering
> 
> Add section number as done in other references to this command

Nit: sentences should end with a dot.

> Signed-off-by: Yehezkel Bernat <YehezkelShB@gmail.com>

Other than that this patch looks good to me, thanks!

Patrick

> ---
>     Documentation: fix linkgit reference
> 
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1706%2FYehezkelShB%2Fyb%2Ffix-linkgit-reference-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1706/YehezkelShB/yb/fix-linkgit-reference-v1
> Pull-Request: https://github.com/git/git/pull/1706
> 
>  Documentation/git-replay.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/git-replay.txt b/Documentation/git-replay.txt
> index f6c269c62d5..8f3300c683a 100644
> --- a/Documentation/git-replay.txt
> +++ b/Documentation/git-replay.txt
> @@ -46,7 +46,7 @@ the new commits (in other words, this mimics a cherry-pick operation).
>  	Range of commits to replay. More than one <revision-range> can
>  	be passed, but in `--advance <branch>` mode, they should have
>  	a single tip, so that it's clear where <branch> should point
> -	to. See "Specifying Ranges" in linkgit:git-rev-parse and the
> +	to. See "Specifying Ranges" in linkgit:git-rev-parse[1] and the
>  	"Commit Limiting" options below.
>  
>  include::rev-list-options.txt[]
> 
> base-commit: 8f7582d995682f785e80e344197cc715e6bc7d8e
> -- 
> gitgitgadget
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] Documentation: fix linkgit reference

[Junio C Hamano]

Patrick Steinhardt <ps@pks.im> writes:

> On Sun, Apr 14, 2024 at 10:08:02PM +0000, Yehezkel Bernat via GitGitGadget wrote:
>> From: Yehezkel Bernat <yehezkelshb@gmail.com>
>> 
>> In git-replay documentation, linkgit to git-rev-parse is missing the man
>> section which breaks its rendering
>> 
>> Add section number as done in other references to this command
>
> Nit: sentences should end with a dot.
>
>> Signed-off-by: Yehezkel Bernat <YehezkelShB@gmail.com>
>
> Other than that this patch looks good to me, thanks!
>
> Patrick

Thanks, both.  Will just tweak the proposed log message while
queuing.


>> ---
>>     Documentation: fix linkgit reference
>> 
>> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1706%2FYehezkelShB%2Fyb%2Ffix-linkgit-reference-v1
>> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1706/YehezkelShB/yb/fix-linkgit-reference-v1
>> Pull-Request: https://github.com/git/git/pull/1706
>> 
>>  Documentation/git-replay.txt | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>> 
>> diff --git a/Documentation/git-replay.txt b/Documentation/git-replay.txt
>> index f6c269c62d5..8f3300c683a 100644
>> --- a/Documentation/git-replay.txt
>> +++ b/Documentation/git-replay.txt
>> @@ -46,7 +46,7 @@ the new commits (in other words, this mimics a cherry-pick operation).
>>  	Range of commits to replay. More than one <revision-range> can
>>  	be passed, but in `--advance <branch>` mode, they should have
>>  	a single tip, so that it's clear where <branch> should point
>> -	to. See "Specifying Ranges" in linkgit:git-rev-parse and the
>> +	to. See "Specifying Ranges" in linkgit:git-rev-parse[1] and the
>>  	"Commit Limiting" options below.
>>  
>>  include::rev-list-options.txt[]
>> 
>> base-commit: 8f7582d995682f785e80e344197cc715e6bc7d8e
>> -- 
>> gitgitgadget
>>