Commit e4f18b4
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 2cd2f56 commit e4f18b4
1 file changed
Lines changed: 10 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -9,22 +9,26 @@ The sources are pulled from: | |||
| 9 | 9 | * nghttp3: https://github.com/ngtcp2/nghttp3 | |
| 10 | 10 | ||
| 11 | 11 | 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. | ||
| 13 | 14 | ||
| 14 | 15 | We only use a subset of the sources for each. | |
| 15 | 16 | ||
| 16 | 17 | ## Updating | |
| 17 | 18 | ||
| 18 | 19 | The `nghttp3` library depends on `ngtcp2`. Both should always be updated | |
| 19 | 20 | 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. | ||
| 21 | 25 | ||
| 22 | 26 | ### Updating ngtcp2 | |
| 23 | 27 | ||
| 24 | - To update ngtcp2: | ||
| 28 | + To update ngtcp2, replace `v0.8.1` with the desired git tag: | ||
| 25 | 29 | ||
| 26 | 30 | ```sh | |
| 27 | - $ git clone https://github.com/ngtcp2/ngtcp2 | ||
| 31 | + $ git clone --depth=1 --branch=v0.8.1 https://github.com/ngtcp2/ngtcp2 | ||
| 28 | 32 | $ cd ngtcp2 | |
| 29 | 33 | $ autoreconf -i | |
| 30 | 34 | $ ./configure --prefix=$PWD/build --enable-lib-only | |
@@ -34,10 +38,10 @@ $ cp -R crypto/* ../node/deps/ngtcp2/ngtcp2/crypto/ | |||
| 34 | 38 | ||
| 35 | 39 | ### Updating nghttp3 | |
| 36 | 40 | ||
| 37 | - To update ngtcp2: | ||
| 41 | + To update nghttp3, replace `v0.7.0` with the desired git tag: | ||
| 38 | 42 | ||
| 39 | 43 | ```sh | |
| 40 | - $ git clone https://github.com/ngtcp2/nghttp3 | ||
| 44 | + $ git clone --depth=1 --branch=v0.7.0 https://github.com/ngtcp2/nghttp3 | ||
| 41 | 45 | $ cd nghttp3 | |
| 42 | 46 | $ autoreconf -i | |
| 43 | 47 | $ ./configure --prefix=$PWD/build --enable-lib-only | |
0 commit comments