| Message ID | 20220916062303.3736166-2-tmz@pobox.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 4945f046c7f5ef6e84f06a5f4abb1bbd18c1eb85 |
| Headers | show |
| Series | api docs: link to html version of api-trace2 | expand |
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.
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 ---------------------------
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(-)