[PATCH 1 of 2] Removed obsolete SPDY documentation
Maxim Dounin
mdounin at mdounin.ru
Sun Jun 4 21:58:42 UTC 2023
Hello!
On Thu, Jun 01, 2023 at 06:16:42PM +0400, Sergey Kandaurov wrote:
> # HG changeset patch
> # User Sergey Kandaurov <pluknet at nginx.com>
> # Date 1685628905 -14400
> # Thu Jun 01 18:15:05 2023 +0400
> # Node ID b891dba3aadb77b0a4621a981edbb1c6a8d3c5be
> # Parent 203f32f5373458548931a706e728fdf94daa6a77
> Removed obsolete SPDY documentation.
>
> diff --git a/xml/en/docs/http/ngx_http_core_module.xml b/xml/en/docs/http/ngx_http_core_module.xml
> --- a/xml/en/docs/http/ngx_http_core_module.xml
> +++ b/xml/en/docs/http/ngx_http_core_module.xml
> @@ -10,7 +10,7 @@
> <module name="Module ngx_http_core_module"
> link="/en/docs/http/ngx_http_core_module.html"
> lang="en"
> - rev="104">
> + rev="105">
>
> <section id="directives" name="Directives">
>
> @@ -1272,8 +1272,7 @@ The “wait-read-ignore” cycle is repeated, but no longer than specified by the
> [<literal>default_server</literal>]
> [<literal>ssl</literal>]
> [<literal>http2</literal> |
> - <literal>quic</literal> |
> - <literal>spdy</literal>]
> + <literal>quic</literal>]
> [<literal>proxy_protocol</literal>]
> [<literal>setfib</literal>=<value>number</value>]
> [<literal>fastopen</literal>=<value>number</value>]
> @@ -1291,8 +1290,7 @@ The “wait-read-ignore” cycle is repeated, but no longer than specified by the
> [<literal>default_server</literal>]
> [<literal>ssl</literal>]
> [<literal>http2</literal> |
> - <literal>quic</literal> |
> - <literal>spdy</literal>]
> + <literal>quic</literal>]
> [<literal>proxy_protocol</literal>]
> [<literal>setfib</literal>=<value>number</value>]
> [<literal>fastopen</literal>=<value>number</value>]
> @@ -1310,8 +1308,7 @@ The “wait-read-ignore” cycle is repeated, but no longer than specified by the
> [<literal>default_server</literal>]
> [<literal>ssl</literal>]
> [<literal>http2</literal> |
> - <literal>quic</literal> |
> - <literal>spdy</literal>]
> + <literal>quic</literal>]
> [<literal>proxy_protocol</literal>]
> [<literal>backlog</literal>=<value>number</value>]
> [<literal>rcvbuf</literal>=<value>size</value>]
> @@ -1395,14 +1392,6 @@ The <literal>quic</literal> parameter (1
> </para>
>
> <para>
> -The <literal>spdy</literal> parameter (1.3.15-1.9.4) allows accepting
> -<link doc="ngx_http_spdy_module.xml">SPDY</link> connections on this port.
> -Normally, for this to work the <literal>ssl</literal> parameter should be
> -specified as well, but nginx can also be configured to accept SPDY
> -connections without SSL.
> -</para>
> -
> -<para>
> The <literal>proxy_protocol</literal> parameter (1.5.12)
> allows specifying that all connections accepted on this port should use the
> <link url="http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">PROXY
> diff --git a/xml/en/docs/http/ngx_http_spdy_module.xml b/xml/en/docs/http/ngx_http_spdy_module.xml
> --- a/xml/en/docs/http/ngx_http_spdy_module.xml
> +++ b/xml/en/docs/http/ngx_http_spdy_module.xml
> @@ -9,155 +9,14 @@
> <module name="Module ngx_http_spdy_module"
> link="/en/docs/http/ngx_http_spdy_module.html"
> lang="en"
> - rev="10">
> + rev="11">
>
> <section id="summary">
>
> <para>
> -The <literal>ngx_http_spdy_module</literal> module provides experimental
> -support for <link url="http://www.chromium.org/spdy/spdy-protocol">SPDY</link>.
> -Currently,
> -<link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft3-1">draft
> -3.1</link> of SPDY protocol is implemented.
> -<note>
> -Before version 1.5.10,
> -<link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2">draft
> -2</link> of SPDY protocol was implemented.
> -</note>
> -</para>
> -
> -<para>
> -This module is not built by default, it should be enabled with
> -the <literal>--with-http_spdy_module</literal>
> -configuration parameter.
> -</para>
> -
> -<para>
> -<note>
> This module was superseded by the
> <link doc="ngx_http_v2_module.xml">ngx_http_v2_module</link> module
> in 1.9.5.
> -</note>
> -</para>
> -
> -</section>
> -
> -
> -<section id="issues" name="Known Issues">
> -
> -<para>
> -The module is experimental, caveat emptor applies.
> -</para>
> -
> -<para>
> -Current implementation of SPDY protocol does not support “server push”.
> -</para>
> -
> -<para>
> -In versions prior to 1.5.9, responses in SPDY connections could not be
> -<link doc="ngx_http_core_module.xml" id="limit_rate">rate limited</link>.
> -</para>
> -
> -<para>
> -Buffering of a client request body cannot be disabled
> -regardless of
> -<link doc="ngx_http_proxy_module.xml" id="proxy_request_buffering"/>,
> -<link doc="ngx_http_fastcgi_module.xml" id="fastcgi_request_buffering"/>,
> -<link doc="ngx_http_uwsgi_module.xml" id="uwsgi_request_buffering"/>, and
> -<link doc="ngx_http_scgi_module.xml" id="scgi_request_buffering"/>
> -directive values.
> -</para>
> -
> -</section>
> -
> -
> -<section id="example" name="Example Configuration">
> -
> -<para>
> -<example>
> -server {
> - listen 443 ssl spdy;
> -
> - ssl_certificate server.crt;
> - ssl_certificate_key server.key;
> - ...
> -}
> -</example>
> -<note>
> -Note that in order to accept both
> -<link doc="ngx_http_ssl_module.xml">HTTPS</link> and SPDY connections
> -simultaneously on the same port,
> -<link url="http://www.openssl.org">OpenSSL</link> library used should support
> -“Next Protocol Negotiation” TLS extension, available since OpenSSL
> -version 1.0.1.
> -</note>
> -</para>
> -
> -</section>
> -
> -
> -<section id="directives" name="Directives">
> -
> -<directive name="spdy_chunk_size">
> -<syntax><value>size</value></syntax>
> -<default>8k</default>
> -<context>http</context>
> -<context>server</context>
> -<context>location</context>
> -<appeared-in>1.5.9</appeared-in>
> -
> -<para>
> -Sets the maximum size of chunks
> -into which the response body is
> -<link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2#TOC-Data-frames">
> -sliced</link>.
> -A too low value results in higher overhead.
> -A too high value impairs prioritization due to
> -<link url="http://en.wikipedia.org/wiki/Head-of-line_blocking">
> -HOL blocking</link>.
> -</para>
> -
> -</directive>
> -
> -
> -<directive name="spdy_headers_comp">
> -<syntax><value>level</value></syntax>
> -<default>0</default>
> -<context>http</context>
> -<context>server</context>
> -
> -<para>
> -Sets the header compression <value>level</value> of a response in a range from
> -1 (fastest, less compression) to 9 (slowest, best compression).
> -The special value 0 turns off the header compression.
> -</para>
> -
> -</directive>
> -
> -</section>
> -
> -
> -<section id="variables" name="Embedded Variables">
> -
> -<para>
> -The <literal>ngx_http_spdy_module</literal> module
> -supports the following embedded variables:
> -<list type="tag" compact="no">
> -
> -<tag-name id="var_spdy"><var>$spdy</var></tag-name>
> -<tag-desc>
> -SPDY protocol version for SPDY connections,
> -or an empty string otherwise;
> -</tag-desc>
> -
> -<tag-name id="var_spdy_request_priority"><var>$spdy_request_priority</var>
> -</tag-name>
> -<tag-desc>
> -request priority for SPDY connections,
> -or an empty string otherwise.
> -</tag-desc>
> -
> -</list>
> </para>
>
> </section>
> diff --git a/xml/en/docs/http/ngx_http_v2_module.xml b/xml/en/docs/http/ngx_http_v2_module.xml
> --- a/xml/en/docs/http/ngx_http_v2_module.xml
> +++ b/xml/en/docs/http/ngx_http_v2_module.xml
> @@ -15,9 +15,8 @@
>
> <para>
> The <literal>ngx_http_v2_module</literal> module (1.9.5) provides
> -support for <link url="https://datatracker.ietf.org/doc/html/rfc7540">HTTP/2</link>
> -and supersedes the
> -<link doc="ngx_http_spdy_module.xml">ngx_http_spdy_module</link> module.
> +support for
> +<link url="https://datatracker.ietf.org/doc/html/rfc7540">HTTP/2</link>.
> </para>
>
> <para>
> diff --git a/xml/en/docs/index.xml b/xml/en/docs/index.xml
> --- a/xml/en/docs/index.xml
> +++ b/xml/en/docs/index.xml
> @@ -8,7 +8,7 @@
> <article name="nginx documentation"
> link="/en/docs/"
> lang="en"
> - rev="48"
> + rev="49"
> toc="no">
>
>
> @@ -434,11 +434,6 @@ ngx_http_slice_module</link>
> </listitem>
>
> <listitem>
> -<link doc="http/ngx_http_spdy_module.xml">
> -ngx_http_spdy_module</link>
> -</listitem>
> -
> -<listitem>
> <link doc="http/ngx_http_split_clients_module.xml">
> ngx_http_split_clients_module</link>
> </listitem>
> diff --git a/xml/ru/docs/http/ngx_http_core_module.xml b/xml/ru/docs/http/ngx_http_core_module.xml
> --- a/xml/ru/docs/http/ngx_http_core_module.xml
> +++ b/xml/ru/docs/http/ngx_http_core_module.xml
> @@ -10,7 +10,7 @@
> <module name="Модуль ngx_http_core_module"
> link="/ru/docs/http/ngx_http_core_module.html"
> lang="ru"
> - rev="104">
> + rev="105">
>
> <section id="directives" name="Директивы">
>
> @@ -1266,8 +1266,7 @@ location /flv/ {
> [<literal>default_server</literal>]
> [<literal>ssl</literal>]
> [<literal>http2</literal> |
> - <literal>quic</literal> |
> - <literal>spdy</literal>]
> + <literal>quic</literal>]
> [<literal>proxy_protocol</literal>]
> [<literal>setfib</literal>=<value>число</value>]
> [<literal>fastopen</literal>=<value>число</value>]
> @@ -1285,8 +1284,7 @@ location /flv/ {
> [<literal>default_server</literal>]
> [<literal>ssl</literal>]
> [<literal>http2</literal> |
> - <literal>quic</literal> |
> - <literal>spdy</literal>]
> + <literal>quic</literal>]
> [<literal>proxy_protocol</literal>]
> [<literal>setfib</literal>=<value>число</value>]
> [<literal>fastopen</literal>=<value>число</value>]
> @@ -1304,8 +1302,7 @@ location /flv/ {
> [<literal>default_server</literal>]
> [<literal>ssl</literal>]
> [<literal>http2</literal> |
> - <literal>quic</literal> |
> - <literal>spdy</literal>]
> + <literal>quic</literal>]
> [<literal>proxy_protocol</literal>]
> [<literal>backlog</literal>=<value>число</value>]
> [<literal>rcvbuf</literal>=<value>размер</value>]
> @@ -1387,14 +1384,6 @@ HTTP/2-соединений без SSL.
> </para>
>
> <para>
> -Параметр <literal>spdy</literal> (1.3.15-1.9.4) позволяет принимать на этом порту
> -<link doc="ngx_http_spdy_module.xml">SPDY</link>-соединения.
> -Обычно, чтобы это работало, следует также указать параметр
> -<literal>ssl</literal>, однако nginx можно также настроить и на приём
> -SPDY-соединений без SSL.
> -</para>
> -
> -<para>
> Параметр <literal>proxy_protocol</literal> (1.5.12)
> указывает на то, что все соединения, принимаемые на данном порту,
> должны использовать
> diff --git a/xml/ru/docs/http/ngx_http_spdy_module.xml b/xml/ru/docs/http/ngx_http_spdy_module.xml
> --- a/xml/ru/docs/http/ngx_http_spdy_module.xml
> +++ b/xml/ru/docs/http/ngx_http_spdy_module.xml
> @@ -9,156 +9,14 @@
> <module name="Модуль ngx_http_spdy_module"
> link="/ru/docs/http/ngx_http_spdy_module.html"
> lang="ru"
> - rev="10">
> + rev="11">
>
> <section id="summary">
>
> <para>
> -Модуль <literal>ngx_http_spdy_module</literal> обеспечивает экспериментальную
> -поддержку <link url="http://www.chromium.org/spdy/spdy-protocol">SPDY</link>.
> -В настоящий момент реализован
> -<link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft3-1">draft
> -3.1</link> протокола SPDY.
> -<note>
> -До версии 1.5.10 был реализован
> -<link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2">draft
> -2</link> протокола SPDY.
> -</note>
> -</para>
> -
> -<para>
> -По умолчанию этот модуль не собирается, его сборку необходимо
> -разрешить с помощью конфигурационного параметра
> -<literal>--with-http_spdy_module</literal>.
> -</para>
> -
> -<para>
> -<note>
> Этот модуль был заменён модулем
> <link doc="ngx_http_v2_module.xml">ngx_http_v2_module</link>
> в версии 1.9.5.
> -</note>
> -</para>
> -
> -</section>
> -
> -
> -<section id="issues" name="Известные проблемы">
> -
> -<para>
> -Модуль экспериментальный, поэтому возможно всё.
> -</para>
> -
> -<para>
> -Текущая реализация протокола SPDY не поддерживает server push.
> -</para>
> -
> -<para>
> -До версии 1.5.9 скорость передачи ответа клиенту в SPDY-соединении не могла быть
> -<link doc="ngx_http_core_module.xml" id="limit_rate">ограничена</link>.
> -</para>
> -
> -<para>
> -Буферизация тела запроса клиента не может быть выключена
> -независимо от значения директив
> -<link doc="ngx_http_proxy_module.xml" id="proxy_request_buffering"/>,
> -<link doc="ngx_http_fastcgi_module.xml" id="fastcgi_request_buffering"/>,
> -<link doc="ngx_http_uwsgi_module.xml" id="uwsgi_request_buffering"/> и
> -<link doc="ngx_http_scgi_module.xml" id="scgi_request_buffering"/>.
> -</para>
> -
> -</section>
> -
> -
> -<section id="example" name="Пример конфигурации">
> -
> -<para>
> -<example>
> -server {
> - listen 443 ssl spdy;
> -
> - ssl_certificate server.crt;
> - ssl_certificate_key server.key;
> - ...
> -}
> -</example>
> -<note>
> -Для того чтобы одновременно принимать
> -<link doc="ngx_http_ssl_module.xml">HTTPS</link> и
> -SPDY соединения на том же порту,
> -используемая библиотека <link url="http://www.openssl.org">OpenSSL</link>
> -должна поддерживать расширение Next Protocol Negotiation протокола TLS,
> -доступное с версии OpenSSL 1.0.1.
> -</note>
> -</para>
> -
> -</section>
> -
> -
> -<section id="directives" name="Директивы">
> -
> -<directive name="spdy_chunk_size">
> -<syntax><value>размер</value></syntax>
> -<default>8k</default>
> -<context>http</context>
> -<context>server</context>
> -<context>location</context>
> -<appeared-in>1.5.9</appeared-in>
> -
> -<para>
> -Задаёт максимальный размер частей,
> -на которые будет
> -<link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2#TOC-Data-frames">
> -разделяться</link> тело ответа.
> -Слишком маленькое значение может
> -привести к росту накладных расходов.
> -Слишком большое значение может
> -негативно сказаться на приоритизации из-за
> -<link url="http://en.wikipedia.org/wiki/Head-of-line_blocking">
> -блокировки очереди</link>.
> -</para>
> -
> -</directive>
> -
> -
> -<directive name="spdy_headers_comp">
> -<syntax><value>степень</value></syntax>
> -<default>0</default>
> -<context>http</context>
> -<context>server</context>
> -
> -<para>
> -Устанавливает <value>степень</value> сжатия заголовков ответа
> -в диапазоне от 1 (быстрее, но хуже сжатие) до 9 (медленнее, лучшее сжатие).
> -Специальное значение 0 отключает сжатие заголовков.
> -</para>
> -
> -</directive>
> -
> -</section>
> -
> -
> -<section id="variables" name="Встроенные переменные">
> -
> -<para>
> -Модуль <literal>ngx_http_spdy_module</literal>
> -поддерживает следующие встроенные переменные:
> -<list type="tag" compact="no">
> -
> -<tag-name id="var_spdy"><var>$spdy</var></tag-name>
> -<tag-desc>
> -версия протокола SPDY для SPDY-соединений,
> -либо пустая строка;
> -</tag-desc>
> -
> -<tag-name id="var_spdy_request_priority"><var>$spdy_request_priority</var>
> -</tag-name>
> -<tag-desc>
> -приоритет запроса для SPDY-соединений,
> -либо пустая строка.
> -</tag-desc>
> -
> -</list>
> </para>
>
> </section>
> diff --git a/xml/ru/docs/http/ngx_http_v2_module.xml b/xml/ru/docs/http/ngx_http_v2_module.xml
> --- a/xml/ru/docs/http/ngx_http_v2_module.xml
> +++ b/xml/ru/docs/http/ngx_http_v2_module.xml
> @@ -15,9 +15,8 @@
>
> <para>
> Модуль <literal>ngx_http_v2_module</literal> (1.9.5) обеспечивает
> -поддержку <link url="https://datatracker.ietf.org/doc/html/rfc7540">HTTP/2</link>
> -и заменяет
> -модуль <link doc="ngx_http_spdy_module.xml">ngx_http_spdy_module</link>.
> +поддержку
> +<link url="https://datatracker.ietf.org/doc/html/rfc7540">HTTP/2</link>.
> </para>
>
> <para>
> diff --git a/xml/ru/docs/index.xml b/xml/ru/docs/index.xml
> --- a/xml/ru/docs/index.xml
> +++ b/xml/ru/docs/index.xml
> @@ -8,7 +8,7 @@
> <article name="nginx: документация"
> link="/ru/docs/"
> lang="ru"
> - rev="48"
> + rev="49"
> toc="no">
>
>
> @@ -439,11 +439,6 @@ ngx_http_slice_module</link>
> </listitem>
>
> <listitem>
> -<link doc="http/ngx_http_spdy_module.xml">
> -ngx_http_spdy_module</link>
> -</listitem>
> -
> -<listitem>
> <link doc="http/ngx_http_split_clients_module.xml">
> ngx_http_split_clients_module</link>
> </listitem>
Looks good.
--
Maxim Dounin
http://mdounin.ru/
More information about the nginx-devel
mailing list