Skip to content

Commit d36c4a3

Browse files
tniessenRafaelGSS
authored andcommitted
deps: update ngtcp2 update instructions
Prefer tagged versions over the latest commit on the development branch, and a few other minor improvements. PR-URL: #44619 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent f158656 commit d36c4a3

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

deps/ngtcp2/README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,26 @@ The sources are pulled from:
99
* nghttp3: https://github.com/ngtcp2/nghttp3
1010

1111
In both the `ngtcp2` and `nghttp3` git repos, the active development occurs
12-
in the default branch (currently named `master` in each).
12+
in the default branch (currently named `main` in each). Tagged versions do not
13+
always point to the default branch.
1314

1415
We only use a subset of the sources for each.
1516

1617
## Updating
1718

1819
The `nghttp3` library depends on `ngtcp2`. Both should always be updated
1920
together. From `ngtcp2` we only want the contents of the `lib` and `crypto`
20-
directories; from `nghttp3` we only want the contents of the `lib`.
21+
directories; from `nghttp3` we only want the contents of the `lib` directory.
22+
23+
After updating either dependency, check if any source files or include
24+
directories have been added or removed and update `ngtcp2.gyp` accordingly.
2125

2226
### Updating ngtcp2
2327

24-
To update ngtcp2:
28+
To update ngtcp2, replace `v0.8.1` with the desired git tag:
2529

2630
```sh
27-
$ git clone https://github.com/ngtcp2/ngtcp2
31+
$ git clone --depth=1 --branch=v0.8.1 https://github.com/ngtcp2/ngtcp2
2832
$ cd ngtcp2
2933
$ autoreconf -i
3034
$ ./configure --prefix=$PWD/build --enable-lib-only
@@ -34,10 +38,10 @@ $ cp -R crypto/* ../node/deps/ngtcp2/ngtcp2/crypto/
3438

3539
### Updating nghttp3
3640

37-
To update ngtcp2:
41+
To update nghttp3, replace `v0.7.0` with the desired git tag:
3842

3943
```sh
40-
$ git clone https://github.com/ngtcp2/nghttp3
44+
$ git clone --depth=1 --branch=v0.7.0 https://github.com/ngtcp2/nghttp3
4145
$ cd nghttp3
4246
$ autoreconf -i
4347
$ ./configure --prefix=$PWD/build --enable-lib-only

0 commit comments

Comments
 (0)