From: Junio C Hamano <gitster@pobox.com>
To: Todd Zullinger <tmz@pobox.com>
Cc: git@vger.kernel.org, "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: Re: [PATCH] docs: fix a few recently broken links
Date: Fri, 16 Sep 2022 08:37:02 -0700 [thread overview]
Message-ID: <xmqqzgezjppd.fsf@gitster.g> (raw)
In-Reply-To: <20220916062303.3736166-1-tmz@pobox.com> (Todd Zullinger's message of "Fri, 16 Sep 2022 02:23:02 -0400")
Todd Zullinger <tmz@pobox.com> writes:
> Some links were broken in the recent move of various technical docs
> c0f6dd49f1 (Merge branch 'ab/tech-docs-to-help', 2022-08-14).
>
> Fix them.
>
> Signed-off-by: Todd Zullinger <tmz@pobox.com>
> ---
Thanks.
It is a bit sad that the links can only be relative (with which, a
move like c0f6dd49f1 can easily break them) or absolute (with which,
it is impossible to "hang" the entire documentation set under some
hierarchy in a larger set of pages). I suppose that use of base
href might help, but it would make the result more cumbersome to set
up with than the fully relative collection of pages, which is what
we have.
> diff --git a/Documentation/technical/bundle-uri.txt b/Documentation/technical/bundle-uri.txt
> index c25c42378a..85c6a7fc7c 100644
> --- a/Documentation/technical/bundle-uri.txt
> +++ b/Documentation/technical/bundle-uri.txt
> @@ -3,8 +3,7 @@ Bundle URIs
>
> Git bundles are files that store a pack-file along with some extra metadata,
> including a set of refs and a (possibly empty) set of necessary commits. See
> -linkgit:git-bundle[1] and link:bundle-format.txt[the bundle format] for more
> -information.
> +linkgit:git-bundle[1] and linkgit:gitformat-bundle[5] for more information.
Good. Thanks for being careful.
> Bundle URIs are locations where Git can download one or more bundles in
> order to bootstrap the object database in advance of fetching the remaining
> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index ca9decdd95..dc9c6a663a 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -3133,7 +3133,7 @@ those "loose" objects.
> You can save space and make Git faster by moving these loose objects in
> to a "pack file", which stores a group of objects in an efficient
> compressed format; the details of how pack files are formatted can be
> -found in link:gitformat-pack[5].
> +found in linkgit:gitformat-pack[5].
This, too.
Will queue.
prev parent reply other threads:[~2022-09-16 15:37 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-16 6:23 [PATCH] docs: fix a few recently broken links Todd Zullinger
2022-09-16 6:23 ` [PATCH] api docs: link to html version of api-trace2 Todd Zullinger
2022-09-16 15:39 ` Junio C Hamano
2022-09-16 15:37 ` Junio C Hamano [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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqzgezjppd.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=avarab@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.
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 NNTP newsgroup(s).