Skip to content

Commit

Permalink
doc: add detail for how to update llhttp
Browse files Browse the repository at this point in the history
Add detail on how to update llhttp in deps to the
guide for maintaining http.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #43028
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
mhdawson authored and juanarbol committed May 31, 2022
1 parent 549bce1 commit 671f85e
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions doc/contributing/maintaining-http.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 671f85e

Please sign in to comment.