Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: maintaining nghttp2 #46539

Merged
merged 4 commits into from
Feb 21, 2023
Merged

doc: maintaining nghttp2 #46539

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
53657ed
doc: maintaining nghttp2
marco-ippolito Feb 7, 2023
831c1eb
doc: fix step
marco-ippolito Feb 7, 2023
71f23db
doc: link http to http2
marco-ippolito Feb 10, 2023
e147cac
doc: fix link
marco-ippolito Feb 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions doc/contributing/maintaining-http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
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.
48 changes: 48 additions & 0 deletions doc/contributing/maintaining-nghttp2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
```

## Step 2: 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
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
$ ./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"
```