* [filter-repo PATCH] fix links to git-fast-import
@ 2022-09-24 3:37 Todd Zullinger
2022-09-24 22:06 ` Elijah Newren
0 siblings, 1 reply; 4+ messages in thread
From: Todd Zullinger @ 2022-09-24 3:37 UTC (permalink / raw)
To: git; +Cc: Elijah Newren
The name of the html and man page for `git-fast-import` is missing the
`git-` prefix. Add it where appropriate.
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 +-
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’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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [filter-repo PATCH] fix links to git-fast-import
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
0 siblings, 1 reply; 4+ messages in thread
From: Elijah Newren @ 2022-09-24 22:06 UTC (permalink / raw)
To: Todd Zullinger; +Cc: Git Mailing List
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’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?
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [filter-repo PATCH] fix links to git-fast-import
2022-09-24 22:06 ` Elijah Newren
@ 2022-09-24 22:38 ` Todd Zullinger
2022-09-25 0:08 ` Elijah Newren
0 siblings, 1 reply; 4+ messages in thread
From: Todd Zullinger @ 2022-09-24 22:38 UTC (permalink / raw)
To: Elijah Newren; +Cc: Git Mailing List
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< --
--
Todd
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [filter-repo PATCH] fix links to git-fast-import
2022-09-24 22:38 ` Todd Zullinger
@ 2022-09-25 0:08 ` Elijah Newren
0 siblings, 0 replies; 4+ messages in thread
From: Elijah Newren @ 2022-09-25 0:08 UTC (permalink / raw)
To: Todd Zullinger; +Cc: Git Mailing List
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!
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-09-25 0:08 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
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).