From 53657ed253d9adf45b5abacd75757bc8e3b377d2 Mon Sep 17 00:00:00 2001 From: Marco Ippolito Date: Tue, 7 Feb 2023 09:49:03 +0100 Subject: [PATCH 1/4] doc: maintaining nghttp2 --- doc/contributing/maintaining-http.md | 13 ------- doc/contributing/maintaining-nghttp2.md | 48 +++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 13 deletions(-) create mode 100644 doc/contributing/maintaining-nghttp2.md diff --git a/doc/contributing/maintaining-http.md b/doc/contributing/maintaining-http.md index a0a2316844c1dd..cb0e0c004a4c68 100644 --- a/doc/contributing/maintaining-http.md +++ b/doc/contributing/maintaining-http.md @@ -108,16 +108,3 @@ 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) directory and C++ code in the [src](https://github.com/nodejs/node/tree/HEAD/src) directory. - -### HTTP2 - -The low-level implementation of -[HTTP2](https://nodejs.org/docs/latest/api/http2.html) -is based on [nghttp2](https://nghttp2.org/). Updates are pulled into Node.js -under [deps/nghttp2](https://github.com/nodejs/node/tree/HEAD/deps/nghttp2) -as needed. - -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) -directory and C++ code in the -[src](https://github.com/nodejs/node/tree/HEAD/src) directory. diff --git a/doc/contributing/maintaining-nghttp2.md b/doc/contributing/maintaining-nghttp2.md new file mode 100644 index 00000000000000..63757720529b8a --- /dev/null +++ b/doc/contributing/maintaining-nghttp2.md @@ -0,0 +1,48 @@ +# Maintaining nghttp2 in Node.js + +The low-level implementation of +[HTTP2](https://nodejs.org/docs/latest/api/http2.html) +is based on [nghttp2](https://nghttp2.org/). Updates are pulled into Node.js +under [deps/nghttp2](https://github.com/nodejs/node/tree/HEAD/deps/nghttp2) +as needed. + +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) +directory and C++ code in the +[src](https://github.com/nodejs/node/tree/HEAD/src) directory. + +## Step 1: Updating nghttp2 + +The `tools/update-nghttp2.sh` script automates the update of the +postject source files. + +In the following examples, `x.y.z` should match the nghttp2 +version to update to. + +```console +$ ./tools/update-nghttp2.sh x.y.z +``` + +## Step 3: Test the build + +```console +$ make test-http2 +``` + +## Step 3: Commit new nghttp2 + +```console +$ git add -A deps/nghttp2 +$ git commit -m "deps: upgrade nghttp2 to x.y.z" +``` + +## Step 4: Update licenses + +```console +$ ./configure +$ make -j4 +$ ./tools/license-builder.sh +# The following commands are only necessary if there are changes +$ git add . +$ git commit -m "doc: update nghttp2 LICENSE using license-builder.sh" +``` From 831c1eb8731e9bb180daa2b5af32ad84c6236914 Mon Sep 17 00:00:00 2001 From: Marco Ippolito Date: Tue, 7 Feb 2023 09:54:36 +0100 Subject: [PATCH 2/4] doc: fix step --- doc/contributing/maintaining-nghttp2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/maintaining-nghttp2.md b/doc/contributing/maintaining-nghttp2.md index 63757720529b8a..3f5888953c6812 100644 --- a/doc/contributing/maintaining-nghttp2.md +++ b/doc/contributing/maintaining-nghttp2.md @@ -23,7 +23,7 @@ version to update to. $ ./tools/update-nghttp2.sh x.y.z ``` -## Step 3: Test the build +## Step 2: Test the build ```console $ make test-http2 From 71f23db67038965bf514b9bb74b1fe03b8994280 Mon Sep 17 00:00:00 2001 From: Marco Ippolito Date: Fri, 10 Feb 2023 15:21:48 +0100 Subject: [PATCH 3/4] doc: link http to http2 --- doc/contributing/maintaining-http.md | 8 ++++++++ doc/contributing/maintaining-nghttp2.md | 2 -- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/contributing/maintaining-http.md b/doc/contributing/maintaining-http.md index cb0e0c004a4c68..4f1efd3911f151 100644 --- a/doc/contributing/maintaining-http.md +++ b/doc/contributing/maintaining-http.md @@ -108,3 +108,11 @@ 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) directory and C++ code in the [src](https://github.com/nodejs/node/tree/HEAD/src) directory. + +### HTTP2 + +The low-level implementation of +[HTTP2](https://nodejs.org/docs/latest/api/http2.html) +is based on [nghttp2](https://nghttp2.org/). See [maintaining nghttp2][]. + +[maintaining nghttp2]: #maintaining-nghttp2.md diff --git a/doc/contributing/maintaining-nghttp2.md b/doc/contributing/maintaining-nghttp2.md index 3f5888953c6812..e75240f107aa35 100644 --- a/doc/contributing/maintaining-nghttp2.md +++ b/doc/contributing/maintaining-nghttp2.md @@ -39,8 +39,6 @@ $ git commit -m "deps: upgrade nghttp2 to x.y.z" ## Step 4: Update licenses ```console -$ ./configure -$ make -j4 $ ./tools/license-builder.sh # The following commands are only necessary if there are changes $ git add . From e147cacddb274112d0ab656c5d5b3dc7cbbf5798 Mon Sep 17 00:00:00 2001 From: Marco Ippolito Date: Sun, 12 Feb 2023 18:31:52 +0100 Subject: [PATCH 4/4] doc: fix link Co-authored-by: Rafael Gonzaga --- 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 4f1efd3911f151..dab06fdc6ed84a 100644 --- a/doc/contributing/maintaining-http.md +++ b/doc/contributing/maintaining-http.md @@ -115,4 +115,4 @@ The low-level implementation of [HTTP2](https://nodejs.org/docs/latest/api/http2.html) is based on [nghttp2](https://nghttp2.org/). See [maintaining nghttp2][]. -[maintaining nghttp2]: #maintaining-nghttp2.md +[maintaining nghttp2]: ./maintaining-nghttp2.md