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 15:06:02 -0700	[thread overview]
Message-ID: <CABPp-BHPYa4Lzj0Kt-q+qyA+qpo3BLkoMoQOo7sPNoo-0RTxKA@mail.gmail.com> (raw)
In-Reply-To: <20220924033708.2409170-1-tmz@pobox.com>

On Fri, Sep 23, 2022 at 8:37 PM Todd Zullinger <tmz@pobox.com> wrote:
>
> The name of the html and man page for `git-fast-import` is missing the
> `git-` prefix.  Add it where appropriate.

Thanks for noticing and reporting.

> Signed-off-by: Todd Zullinger <tmz@pobox.com>
> ---
> Hi Elijah,
>
> 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.

>  2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/html/git-filter-repo.html b/html/git-filter-repo.html
> index 3143fd9..5119fa2 100644
> --- a/html/git-filter-repo.html
> +++ b/html/git-filter-repo.html
> @@ -2167,7 +2167,7 @@ that filter-repo uses bytestrings (see
>  instead of strings.</p></div>
>  <div class="paragraph"><p>There are four callbacks that allow you to operate directly on raw
>  objects that contain data that&#8217;s easy to write in
> -<a href="fast-import.html">fast-import(1)</a> format:</p></div>
> +<a href="git-fast-import.html">git-fast-import(1)</a> format:</p></div>
>  <div class="listingblock">
>  <div class="content">
>  <pre><code>--blob-callback
> diff --git a/man1/git-filter-repo.1 b/man1/git-filter-repo.1
> index 188fd2a..9f9bbfc 100644
> --- a/man1/git-filter-repo.1
> +++ b/man1/git-filter-repo.1
> @@ -1512,7 +1512,7 @@ def foo_callback(foo):
>  .sp
>  Thus, you just need to make sure your \fIBODY\fR modifies and returns \fIfoo\fR appropriately\&. One important thing to note for all callbacks is that filter\-repo uses bytestrings (see \m[blue]\fBhttps://docs\&.python\&.org/3/library/stdtypes\&.html#bytes\fR\m[]) everywhere instead of strings\&.
>  .sp
> -There are four callbacks that allow you to operate directly on raw objects that contain data that\(cqs easy to write in \fBfast-import\fR(1) format:
> +There are four callbacks that allow you to operate directly on raw objects that contain data that\(cqs easy to write in \fBgit-fast-import\fR(1) format:
>  .sp
>  .if n \{\
>  .RS 4
> --
> 2.38.0.rc1

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?

  reply	other threads:[~2022-09-24 22:06 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 [this message]
2022-09-24 22:38   ` Todd Zullinger
2022-09-25  0:08     ` Elijah Newren

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-BHPYa4Lzj0Kt-q+qyA+qpo3BLkoMoQOo7sPNoo-0RTxKA@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).