doc: add detail for how to update llhttp

Add detail on how to update llhttp in deps to the guide for maintaining http. Signed-off-by: Michael Dawson <[email protected]> PR-URL: #43028 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Jul 31, 2022 · 9101aa8 · 9101aa8
1 parent c6f87e7
commit 9101aa8
Showing 1 changed file with 28 additions and 2 deletions.
diff --git a/doc/contributing/maintaining-http.md b/doc/contributing/maintaining-http.md
@@ -74,9 +74,35 @@ to align them with the APIs built for the client.
 The low-level implementation of the
 [HTTP](https://nodejs.org/docs/latest/api/http.html)
 and [HTTPS](https://nodejs.org/docs/latest/api/https.html) APIs
-are maintained in the [llttp](https://github.com/nodejs/llhttp)
+are maintained in the [llhttp](https://github.com/nodejs/llhttp)
 repository. Updates are pulled into Node.js under
-[deps/llhttp](https://github.com/nodejs/node/tree/HEAD/deps/llhttp)
+[deps/llhttp](https://github.com/nodejs/node/tree/HEAD/deps/llhttp).
+
+In order to update Node.js with a new version of llhttp:
+
+* check out the tagged release that you want to update to (a release
+  should be created in the llhttp repo before updating Node.js).
+* run `npm install` in the directory that you checked out llhttp.
+* run `make release` in the directory that you checked out llhttp.
+* copy the contents of the `release` directory from the directory you
+  checked llhttp out to
+  [deps/llhttp](https://github.com/nodejs/node/tree/HEAD/deps/llhttp)
+
+It should look like the following:
+
+```console
+├── CMakeLists.txt
+├── common.gypi
+├── include
+│   └── llhttp.h
+├── LICENSE-MIT
+├── llhttp.gyp
+├── README.md
+└── src
+    ├── api.c
+    ├── http.c
+    └── llhttp.c
+```
 
 The low-level implementation is made available in the Node.js API through
 JavaScript code in the [lib](https://github.com/nodejs/node/tree/HEAD/lib)