Re: [filter-repo PATCH] fix links to git-fast-import

From: Todd Zullinger <tmz@pobox.com>
Date: Sep 24, 2022, 22:38 UTC
Message-ID: <Yy+GzB0gTBHaJJw1@pobox.com>
In-Reply-To: <CABPp-BHPYa4Lzj0Kt-q+qyA+qpo3BLkoMoQOo7sPNoo-0RTxKA@mail.gmail.com>

Hi,

Elijah Newren wrote:

Show 13 quoted lines

> On Fri, Sep 23, 2022 at 8:37 PM Todd Zullinger <tmz@pobox.com> wrote:
>> I noticed the link to git-fast-import.html in git-filter-repo.html was
>> missing the `git-` prefix.  The man page similarly lacked it when
>> referencing it.
>>
>>  html/git-filter-repo.html | 2 +-
>>  man1/git-filter-repo.1    | 2 +-
> 
> Neither of these files are tracked; both are auto-generated.  I do
> stuff them into the "docs" branch so people can grab them...but
> they'll just be wiped out and overwritten the next time I build the
> docs.  So, either the documentation source file is wrong, or the build
> process is.

D'oh! I should have looked closer at the build process. Somehow I saw the docs branch and just _assumed_ it was the source. And that required looking right past the asciidoc version in Documentation/ on the main branch. ;)

I was clearly a few too many tangents deep.

Show 7 quoted lines

> Is the real problem that in this text from Documentation/git-filter-repo.txt:
> 
>     There are four callbacks that allow you to operate directly on raw
>     objects that contain data that's easy to write in
>     linkgit:fast-import[1] format:
> 
> that there should be a "git-" on the last line?

Indeed, thanks.

This should work (I tested by symlinking git-filter-repo.txt to git's Documentation, as the Makefile does):

-- 8< --
Subject: [PATCH] git-filter-repo.txt: add missing `git-` prefix to fast-import
 link

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 Documentation/git-filter-repo.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-filter-repo.txt b/Documentation/git-filter-repo.txt
index 9c00a78..09374a4 100644
--- a/Documentation/git-filter-repo.txt
+++ b/Documentation/git-filter-repo.txt
@@ -1047,7 +1047,7 @@ instead of strings.
 
 There are four callbacks that allow you to operate directly on raw
 objects that contain data that's easy to write in
-linkgit:fast-import[1] format:
+linkgit:git-fast-import[1] format:
 
 --------------------------------------------------
 --blob-callback
-- 8< --

-- 
Todd