From 41bbfc51f5343e09a69f70841ce3357571fc37ba Mon Sep 17 00:00:00 2001 From: Pranshu Srivastava Date: Sat, 23 May 2020 03:25:32 +0530 Subject: [PATCH 1/5] doc: specify maxHeaderCount alias for maxHeaderListPairs Fixes: https://github.com/nodejs/node/issues/32388 --- doc/api/http2.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index 5a0f750a258a36..401039b9a96bb8 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2055,7 +2055,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - The minimum value is `4`. **Default:** `128`. + This is similar to `HTTP/1`'s `maxHeaderCount`. The minimum value is `4`. + **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. * `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a @@ -2194,7 +2195,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - The minimum value is `4`. **Default:** `128`. + This is similar to `HTTP/1`'s `maxHeaderCount`. The minimum value is `4`. + **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. * `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a @@ -2307,7 +2309,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - The minimum value is `1`. **Default:** `128`. + This is similar to `HTTP/1`'s `maxHeaderCount`. The minimum value is `1`. + **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. * `maxReservedRemoteStreams` {number} Sets the maximum number of reserved push From 1adf51f6b345e7c9bc7f07149cb34e8029f762b5 Mon Sep 17 00:00:00 2001 From: Pranshu Srivastava Date: Sat, 23 May 2020 19:54:40 +0530 Subject: [PATCH 2/5] nit --- doc/api/http2.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index 401039b9a96bb8..11d8435bfa51e8 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2055,7 +2055,7 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `HTTP/1`'s `maxHeaderCount`. The minimum value is `4`. + This is similar to `HTTP/1`'s `maxHeadersCount`. The minimum value is `4`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. @@ -2195,7 +2195,7 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `HTTP/1`'s `maxHeaderCount`. The minimum value is `4`. + This is similar to `HTTP/1`'s `maxHeadersCount`. The minimum value is `4`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. @@ -2309,7 +2309,7 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `HTTP/1`'s `maxHeaderCount`. The minimum value is `1`. + This is similar to `HTTP/1`'s `maxHeadersCount`. The minimum value is `1`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. From f6cd83b613a47a44d8d3450b01739a4fda3e5700 Mon Sep 17 00:00:00 2001 From: Pranshu Srivastava Date: Sun, 7 Jun 2020 04:33:03 +0530 Subject: [PATCH 3/5] add both aliases --- doc/api/http2.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index 11d8435bfa51e8..1720ce6fd5cf49 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2055,7 +2055,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `HTTP/1`'s `maxHeadersCount`. The minimum value is `4`. + This is similar to `http.Server#maxHeadersCount` (or + `http.ClientRequest#maxHeadersCount`). The minimum value is `4`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. @@ -2195,7 +2196,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `HTTP/1`'s `maxHeadersCount`. The minimum value is `4`. + This is similar to `http.Server#maxHeadersCount` (or + `http.ClientRequest#maxHeadersCount`). The minimum value is `4`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. @@ -2309,7 +2311,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `HTTP/1`'s `maxHeadersCount`. The minimum value is `1`. + This is similar to `http.Server#maxHeadersCount` (or + `http.ClientRequest#maxHeadersCount`). The minimum value is `1`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. From d22419f9f9b77191578a4348ccad4d900557b8a8 Mon Sep 17 00:00:00 2001 From: Pranshu Srivastava Date: Sun, 7 Jun 2020 10:18:04 +0530 Subject: [PATCH 4/5] remove parentheses --- doc/api/http2.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index 1720ce6fd5cf49..939d161850e520 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2055,8 +2055,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `http.Server#maxHeadersCount` (or - `http.ClientRequest#maxHeadersCount`). The minimum value is `4`. + This is similar to `http.Server#maxHeadersCount` or + `http.ClientRequest#maxHeadersCount`. The minimum value is `4`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. @@ -2196,8 +2196,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `http.Server#maxHeadersCount` (or - `http.ClientRequest#maxHeadersCount`). The minimum value is `4`. + This is similar to `http.Server#maxHeadersCount` or + `http.ClientRequest#maxHeadersCount`. The minimum value is `4`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. @@ -2311,8 +2311,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `http.Server#maxHeadersCount` (or - `http.ClientRequest#maxHeadersCount`). The minimum value is `1`. + This is similar to `http.Server#maxHeadersCount` or + `http.ClientRequest#maxHeadersCount`. The minimum value is `1`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. From a4aa3431d48cc41cbfe89389440aedc91de7f9b6 Mon Sep 17 00:00:00 2001 From: Pranshu Srivastava Date: Sat, 20 Jun 2020 20:37:18 +0530 Subject: [PATCH 5/5] add links --- doc/api/http2.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index 939d161850e520..e2b1a0945f4a5f 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2055,8 +2055,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `http.Server#maxHeadersCount` or - `http.ClientRequest#maxHeadersCount`. The minimum value is `4`. + This is similar to [`http.Server#maxHeadersCount`][] or + [`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. @@ -2196,8 +2196,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `http.Server#maxHeadersCount` or - `http.ClientRequest#maxHeadersCount`. The minimum value is `4`. + This is similar to [`http.Server#maxHeadersCount`][] or + [`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. @@ -2311,8 +2311,8 @@ changes: queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all counted towards the current limit. **Default:** `10`. * `maxHeaderListPairs` {number} Sets the maximum number of header entries. - This is similar to `http.Server#maxHeadersCount` or - `http.ClientRequest#maxHeadersCount`. The minimum value is `1`. + This is similar to [`http.Server#maxHeadersCount`][] or + [`http.ClientRequest#maxHeadersCount`][]. The minimum value is `1`. **Default:** `128`. * `maxOutstandingPings` {number} Sets the maximum number of outstanding, unacknowledged pings. **Default:** `10`. @@ -3645,6 +3645,8 @@ following additional properties: [`Http2Stream`]: #http2_class_http2stream [`ServerHttp2Stream`]: #http2_class_serverhttp2stream [`TypeError`]: errors.html#errors_class_typeerror +[`http.ClientRequest#maxHeadersCount`]: http.html#http_request_maxheaderscount +[`http.Server#maxHeadersCount`]: http.html#http_server_maxheaderscount [`http2.SecureServer`]: #http2_class_http2secureserver [`http2.Server`]: #http2_class_http2server [`http2.createSecureServer()`]: #http2_http2_createsecureserver_options_onrequesthandler