[PATCH] docs: fix a few recently broken links

[PATCH] docs: fix a few recently broken links

[Todd Zullinger]

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>
---
 Documentation/gitprotocol-capabilities.txt | 4 ++--
 Documentation/gitprotocol-v2.txt           | 4 ++--
 Documentation/technical/bundle-uri.txt     | 3 +--
 Documentation/user-manual.txt              | 2 +-
 4 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/Documentation/gitprotocol-capabilities.txt b/Documentation/gitprotocol-capabilities.txt
index c6dcc7d565..0fb5ea0c1c 100644
--- a/Documentation/gitprotocol-capabilities.txt
+++ b/Documentation/gitprotocol-capabilities.txt
@@ -388,8 +388,8 @@ the server as well.
 Session IDs should be unique to a given process. They must fit within a
 packet-line, and must not contain non-printable or whitespace characters. The
 current implementation uses trace2 session IDs (see
-link:api-trace2.html[api-trace2] for details), but this may change and users of
-the session ID should not rely on this fact.
+link:technical/api-trace2.html[api-trace2] for details), but this may change
+and users of the session ID should not rely on this fact.
 
 GIT
 ---
diff --git a/Documentation/gitprotocol-v2.txt b/Documentation/gitprotocol-v2.txt
index c9c0f9160b..59bf41cefb 100644
--- a/Documentation/gitprotocol-v2.txt
+++ b/Documentation/gitprotocol-v2.txt
@@ -544,8 +544,8 @@ the server as well.
 Session IDs should be unique to a given process. They must fit within a
 packet-line, and must not contain non-printable or whitespace characters. The
 current implementation uses trace2 session IDs (see
-link:api-trace2.html[api-trace2] for details), but this may change and users of
-the session ID should not rely on this fact.
+link:technical/api-trace2.html[api-trace2] for details), but this may change
+and users of the session ID should not rely on this fact.
 
 object-info
 ~~~~~~~~~~~
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.
 
 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].
 
 To put the loose objects into a pack, just run git repack:
 

[PATCH] api docs: link to html version of api-trace2

[Todd Zullinger]

In f6d25d7878 (api docs: document that BUG() emits a trace2 error event,
2021-04-13), a link to the plain text version of api-trace2 was added in
`technical/api-error-handling.txt`.

All of our other `link:`s point to the html versions.  Do the same here.

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
This is minor, but I noticed it while working on the previous patch.  The
effect can be see at [1] where we link to [2].

Somewhat related, it also appears that the link to the API docs in the "Further
documentation" section on git-scm.com is broken entirely[3].  I didn't try to
chase down why that might be, but perhaps someone who knows the site build
process can fix it up.

[1] https://mirrors.edge.kernel.org/pub/software/scm/git/docs/technical/api-error-handling.html
[2] https://mirrors.edge.kernel.org/pub/software/scm/git/docs/technical/api-trace2.txt
[3] https://git-scm.com/docs/git#_further_documentation

 Documentation/technical/api-error-handling.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/technical/api-error-handling.txt b/Documentation/technical/api-error-handling.txt
index 70bf1d3e52..665c4960b4 100644
--- a/Documentation/technical/api-error-handling.txt
+++ b/Documentation/technical/api-error-handling.txt
@@ -46,7 +46,7 @@ parse-options.c.
   returns -1 after reporting the situation to the caller.
 
 These reports will be logged via the trace2 facility. See the "error"
-event in link:api-trace2.txt[trace2 API].
+event in link:api-trace2.html[trace2 API].
 
 Customizable error handlers
 ---------------------------

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

[Junio C Hamano]

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.

Re: [PATCH] api docs: link to html version of api-trace2

[Junio C Hamano]

Todd Zullinger <tmz@pobox.com> writes:

> In f6d25d7878 (api docs: document that BUG() emits a trace2 error event,
> 2021-04-13), a link to the plain text version of api-trace2 was added in
> `technical/api-error-handling.txt`.
>
> All of our other `link:`s point to the html versions.  Do the same here.
>
> Signed-off-by: Todd Zullinger <tmz@pobox.com>
> ---
> This is minor, but I noticed it while working on the previous patch.  The
> effect can be see at [1] where we link to [2].

Thanks.