svn commit: r1935474 - httpd/httpd/trunk/docs/manual
[email protected] Thu, 18 Jun 2026 13:18:54 -0000
| Newsgroups | gmane.comp.apache.cvs |
|---|---|
| Message-ID | <178178873407.2999646.6758505532705045001@svn03-he-fi> |
Author: rbowen Date: Thu Jun 18 13:18:53 2026 New Revision: 1935474 Log: Updates AGENTS.md to reflect usage of the <rfc> tag that was added earlier this year. Modified: httpd/httpd/trunk/docs/manual/AGENTS.md Modified: httpd/httpd/trunk/docs/manual/AGENTS.md ============================================================================== --- httpd/httpd/trunk/docs/manual/AGENTS.md Thu Jun 18 13:17:45 2026 (r1935473) +++ httpd/httpd/trunk/docs/manual/AGENTS.md Thu Jun 18 13:18:53 2026 (r1935474) @@ -27,14 +27,33 @@ This is the documentation source for the ## External Link Conventions +### `<rfc>` — RFC References -Always link to the IETF Datatracker for RFC references: +Use the `<rfc>` tag for all RFC references. The element content is the +RFC number (digits only). The rendered output is "RFC NNNN" linked to +the canonical URL. + +```xml +<rfc>7230</rfc> +<rfc>9110</rfc> ``` -https://datatracker.ietf.org/doc/html/rfcNNNN + +To link to a numbered section, use the `section` attribute: +```xml +<rfc section="14.24">2616</rfc> +``` + +To link to a named anchor (appendix, named heading, etc.), use `anchor`: +```xml +<rfc anchor="appendix-B">7231</rfc> +<rfc anchor="name-upgrade">9110</rfc> ``` -For section-specific links, use fragment anchors: `#section-N.N` -Do NOT use `tools.ietf.org`, `www.rfc-editor.org`, `www.ietf.org/rfc/`, `www.w3.org/Protocols/`, `www.faqs.org/rfcs/`, or any other RFC mirror. These are legacy patterns — `datatracker.ietf.org` is the canonical standard for this documentation. +Do **not** use both `section` and `anchor` on the same element. + +Do **not** use `<a href="...">` with RFC URLs when the `<rfc>` tag can +express the link. Use `<a>` only for non-RFC resources, IETF drafts, or +cases where the display text must differ from "RFC NNNN". ## Directive Syntax Definitions