Re: [PATCH] docs: fix a few recently broken links

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 16, 2022, 15:37 UTC
Message-ID: <xmqqzgezjppd.fsf@gitster.g>
In-Reply-To: <20220916062303.3736166-1-tmz@pobox.com>

Todd Zullinger <tmz@pobox.com> writes:

Show 7 quoted lines

> 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.

Show 11 quoted lines

> 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.

Show 12 quoted lines

>  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.