|
| 1 | +# Maintaining ngtcp2 and nghttp3 |
| 2 | + |
| 3 | +The ngtcp2 and nghttp3 libraries form the foundation of the QUIC |
| 4 | +implementation. They are acquired from the [ngtcp2/ngtcp2][] and |
| 5 | +[ngtcp2/nghttp3][] repositories on GitHub. |
| 6 | + |
| 7 | +ngtcp2 and nghttp3 are tightly related. They will typically be |
| 8 | +updated together. |
| 9 | + |
| 10 | +## Updating ngtcp2 |
| 11 | + |
| 12 | +Update ngtcp2: |
| 13 | +```shell |
| 14 | +git clone https://github.com/ngtcp2/ngtcp2 |
| 15 | +cd ngtcp2 |
| 16 | +autoreconf -i |
| 17 | +./configure --enable-lib-only |
| 18 | +cd .. |
| 19 | +cp -R ngtcp2/crypto node/deps/ngtcp2 |
| 20 | +cp -R ngtcp2/lib node/deps/ngtcp2 |
| 21 | +``` |
| 22 | + |
| 23 | +The `autoreconf -i` and `./configure --enable-lib-only` commands |
| 24 | +ensure that the necessary template files (such as version.h.in |
| 25 | +located in lib/includes/ngtcp2/ are processed appropriately. |
| 26 | + |
| 27 | +Check that Node.js still builds and tests. |
| 28 | + |
| 29 | +## Updating nghttp3 |
| 30 | + |
| 31 | +Update nghttp3: |
| 32 | +```shell |
| 33 | +git clone https://github.com/ngtcp2/nghttp3 |
| 34 | +cd nghttp3 |
| 35 | +autoreconf -i |
| 36 | +./configure --enable-lib-only |
| 37 | +cd .. |
| 38 | +cp -R nghttp3/lib node/deps/nghttp3 |
| 39 | +``` |
| 40 | + |
| 41 | +The `autoreconf -i` and `./configure --enable-lib-only` commands |
| 42 | +ensure that the necessary template files (such as version.h.in |
| 43 | +located in lib/includes/ngtcp2/ are processed appropriately. |
| 44 | + |
| 45 | +Check that Node.js still builds and tests. |
| 46 | + |
| 47 | +## Commiting ngtcp2 and nghttp3 |
| 48 | + |
| 49 | +Use: `git add --all deps/ngtcp2` and `git add --all deps/nghttp3` |
| 50 | + |
| 51 | +Commit the changes with a message like |
| 52 | +```text |
| 53 | +deps: update ngtcp2 and nghttp3 |
| 54 | +
|
| 55 | +Updated as described in doc/guides/maintaining-ngtcp2-nghttp3.md. |
| 56 | +``` |
| 57 | + |
| 58 | +[ngtcp2/nghttp3]: https://github.com/ngtcp2/nghttp3 |
| 59 | +[ngtcp2/ngtcp2]: https://github.com/ngtcp2/ngtcp2 |
0 commit comments