https://i.han.rs • 这是Web Feed，又称为Atom Feed，把现在的网址复制到新闻阅读器即可订阅本站文章。造访「About Feeds」来了解更多资讯。 造访网站 近期文章 更新于 $DATE date RFC Emmm? Zola 2026-04-30T00:00:00+00:00 https://i.han.rs/tags/rfc/atom.xml 2026-04-30T00:00:00+00:00 2026-04-30T00:00:00+00:00 Hantong Chen https://i.han.rs/blog/26-04-30-instructions-on-building-rfc-docs/ <h2 id="prerequisites">Prerequisites</h2> <h3 id="python">Python</h3> <ol> <li>Python 3.x, here we use Python 3.14.1</li> <li>Python virtual environment (optional but recommended)</li> </ol> <p>Using pyenv:</p> <pre data-lang="bash" class="language-bash z-code"><code class="language-bash" data-lang="bash"><span class="z-source z-shell z-bash"><span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">pyenv</span></span><span class="z-meta z-function-call z-arguments z-shell"> install 3.14.1</span> </span><span class="z-source z-shell z-bash"><span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">pyenv</span></span><span class="z-meta z-function-call z-arguments z-shell"> virtualenv 3.14.1 rfc</span> </span><span class="z-source z-shell z-bash"><span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">pyenv</span></span><span class="z-meta z-function-call z-arguments z-shell"> activate rfc</span> </span></code></pre> <p>And then install the required packages:</p> <pre data-lang="bash" class="language-bash z-code"><code class="language-bash" data-lang="bash"><span class="z-source z-shell z-bash"><span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">pip</span></span><span class="z-meta z-function-call z-arguments z-shell"> install sortedcontainers</span> </span></code></pre> <h3 id="nodejs">NodeJS</h3> <p>We make use of <code>aasvg</code>, just install it globally:</p> <pre data-lang="bash" class="language-bash z-code"><code class="language-bash" data-lang="bash"><span class="z-source z-shell z-bash"><span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">npm</span></span><span class="z-meta z-function-call z-arguments z-shell"> install<span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> -</span>g</span> aasvg</span> </span></code></pre> <h3 id="ietf-toolchains">IETF toolchains</h3> <p>We need <code>kramdown-rfc</code> and <code>xml2rfc</code>:</p> <pre data-lang="sh" class="language-sh z-code"><code class="language-sh" data-lang="sh"><span class="z-source z-shell z-bash"><span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">apt</span></span><span class="z-meta z-function-call z-arguments z-shell"> install kramdown-rfc xml2rfc</span> </span></code></pre> <p>And then run <code>make</code> to install other dependencies. This will try to build the document, but it will fail.</p> <h2 id="building-the-document">Building the document</h2> <p>Run the following command to build the HTML:</p> <pre data-lang="sh" class="language-sh z-code"><code class="language-sh" data-lang="sh"><span class="z-source z-shell z-bash"><span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">cat</span></span><span class="z-meta z-function-call z-arguments z-shell"> draft-ietf-tls-rfc8446bis.md</span> <span class="z-keyword z-operator z-logical z-pipe z-shell">|</span> <span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">lib/trace.sh</span></span><span class="z-meta z-function-call z-arguments z-shell"><span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> -</span>v</span> draft-ietf-tls-rfc8446bis.xml<span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> -</span>s</span> preprocessor python3 mk-appendix.py</span> <span class="z-keyword z-operator z-logical z-pipe z-shell">|</span> <span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">kramdown-rfc</span></span><span class="z-meta z-function-call z-arguments z-shell"><span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> --</span>v3</span></span> <span class="z-keyword z-operator z-logical z-pipe z-shell">|</span> <span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">lib/trace.sh</span></span><span class="z-meta z-function-call z-arguments z-shell"><span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> -</span>v</span><span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> -</span>q</span> draft-ietf-tls-rfc8446bis.xml<span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> -</span>s</span> v2v3 xml2rfc<span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> -</span>q</span><span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> --</span>rfc-base-url</span> https://www.rfc-editor.org/rfc/<span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> --</span>id-base-url</span> https://datatracker.ietf.org/doc/html/<span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> --</span>allow-local-file-access</span><span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> --</span>cache</span><span class="z-keyword z-operator z-assignment z-option z-shell">=</span>./.refcache<span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> --</span>v2v3</span> /dev/stdin<span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> -</span>o</span> /dev/stdout <span class="z-keyword z-operator z-assignment z-redirection z-shell">&gt;</span> draft-ietf-tls-rfc8446bis.xml</span> <span class="z-keyword z-operator z-logical z-and z-shell">&amp;&amp;</span> <span class="z-meta z-function-call z-shell"><span class="z-variable z-function z-shell">xml2rfc</span></span><span class="z-meta z-function-call z-arguments z-shell"> draft-ietf-tls-rfc8446bis.xml<span class="z-variable z-parameter z-option z-shell"><span class="z-punctuation z-definition z-parameter z-shell"> --</span>html</span></span> </span></code></pre> <p>This is modified from the CI build script, removing step <code>lib/trace.sh -v -q draft-ietf-tls-rfc8446bis.xml -s venue python3 lib/add-note.py</code> since it failed locally for me.</p> <p>If you want a cleaner way, run <code>make clean</code> in advance.</p>

仅供参考.