From 5a06ec8402967b805b0073c00d72f10c3351df85 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 9 May 2022 17:15:43 -0400 Subject: [PATCH 1/6] 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 --- doc/contributing/maintaining-http.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/doc/contributing/maintaining-http.md b/doc/contributing/maintaining-http.md index 0737b2f9880d66..7a57100d64c073 100644 --- a/doc/contributing/maintaining-http.md +++ b/doc/contributing/maintaining-http.md @@ -76,7 +76,31 @@ The low-level implementation of the and [HTTPS](https://nodejs.org/docs/latest/api/https.html) APIs are maintained in the [llttp](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: + +├── 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) From 2bbf2e6c126b504bda034aa3eae50e7001aceca9 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 9 May 2022 17:23:48 -0400 Subject: [PATCH 2/6] fixup --- doc/contributing/maintaining-http.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/maintaining-http.md b/doc/contributing/maintaining-http.md index 7a57100d64c073..5f49bda8c9c8d9 100644 --- a/doc/contributing/maintaining-http.md +++ b/doc/contributing/maintaining-http.md @@ -74,7 +74,7 @@ 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). From 53f140807f30dfc666b6c69ffedd377efff24a2e Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 9 May 2022 17:24:36 -0400 Subject: [PATCH 3/6] fixup --- doc/contributing/maintaining-http.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/contributing/maintaining-http.md b/doc/contributing/maintaining-http.md index 5f49bda8c9c8d9..573bf5b33c29f5 100644 --- a/doc/contributing/maintaining-http.md +++ b/doc/contributing/maintaining-http.md @@ -90,6 +90,7 @@ In order to update Node.js with a new version of llhttp: It should look like the following: +```shell ├── CMakeLists.txt ├── common.gypi ├── include @@ -101,6 +102,7 @@ It should look like the following: ├── 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) From 939e3ba50892826d7154869759ec06cbc7355b8a Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 9 May 2022 18:07:29 -0400 Subject: [PATCH 4/6] Update doc/contributing/maintaining-http.md Co-authored-by: Mohammed Keyvanzadeh --- doc/contributing/maintaining-http.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/maintaining-http.md b/doc/contributing/maintaining-http.md index 573bf5b33c29f5..21539301534785 100644 --- a/doc/contributing/maintaining-http.md +++ b/doc/contributing/maintaining-http.md @@ -81,7 +81,7 @@ repository. Updates are pulled into Node.js under 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) + 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 From 62ab05b8b0bf4aa13237e5134b8ad833fbaa7f0d Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 9 May 2022 18:08:06 -0400 Subject: [PATCH 5/6] fixup --- doc/contributing/maintaining-http.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/maintaining-http.md b/doc/contributing/maintaining-http.md index 21539301534785..e56719c7e9f022 100644 --- a/doc/contributing/maintaining-http.md +++ b/doc/contributing/maintaining-http.md @@ -90,7 +90,7 @@ In order to update Node.js with a new version of llhttp: It should look like the following: -```shell +```console ├── CMakeLists.txt ├── common.gypi ├── include From 1bfefe617f241f49e049f7497b20abc25a341b56 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Tue, 10 May 2022 09:38:12 -0400 Subject: [PATCH 6/6] Update doc/contributing/maintaining-http.md Co-authored-by: Darshan Sen --- doc/contributing/maintaining-http.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/contributing/maintaining-http.md b/doc/contributing/maintaining-http.md index e56719c7e9f022..2888367d861103 100644 --- a/doc/contributing/maintaining-http.md +++ b/doc/contributing/maintaining-http.md @@ -99,9 +99,9 @@ It should look like the following: ├── llhttp.gyp ├── README.md └── src -├── api.c -├── http.c -└── llhttp.c + ├── api.c + ├── http.c + └── llhttp.c ``` The low-level implementation is made available in the Node.js API through