git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Elijah Newren <newren@gmail.com>
To: Todd Zullinger <tmz@pobox.com>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: Re: [filter-repo PATCH] fix links to git-fast-import
Date: Sat, 24 Sep 2022 17:08:32 -0700	[thread overview]
Message-ID: <CABPp-BFwJr7xLhdbdbh+eFhaSF36cLEzKbzc7gpuit=iC2Eejg@mail.gmail.com> (raw)
In-Reply-To: <Yy+GzB0gTBHaJJw1@pobox.com>

On Sat, Sep 24, 2022 at 3:38 PM Todd Zullinger <tmz@pobox.com> wrote:
>
> Hi,
>
> Elijah Newren wrote:
> > 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.
>
> > 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< --

Thanks, applied!

      reply	other threads:[~2022-09-25  0:08 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-24  3:37 [filter-repo PATCH] fix links to git-fast-import Todd Zullinger
2022-09-24 22:06 ` Elijah Newren
2022-09-24 22:38   ` Todd Zullinger
2022-09-25  0:08     ` Elijah Newren [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CABPp-BFwJr7xLhdbdbh+eFhaSF36cLEzKbzc7gpuit=iC2Eejg@mail.gmail.com' \
    --to=newren@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=tmz@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).