From 132719f752993525c7c2faadf19f5f723ade52f6 Mon Sep 17 00:00:00 2001 From: Syohei YOSHIDA Date: Tue, 12 May 2015 10:49:42 +0900 Subject: [PATCH 1/2] Correct misspellings in document --- README.rst | 6 +++--- doc/h2load.1 | 2 +- doc/h2load.1.rst | 2 +- doc/nghttpx.1 | 2 +- doc/nghttpx.1.rst | 2 +- doc/sources/h2load-howto.rst | 2 +- doc/sources/libnghttp2_asio.rst | 4 ++-- doc/sources/nghttpx-howto.rst | 4 ++-- doc/sources/python-apiref.rst | 2 +- doc/sources/tutorial-client.rst | 10 +++++----- doc/sources/tutorial-hpack.rst | 2 +- 11 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index 3bade963..02f33e18 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,7 @@ An HPACK encoder and decoder are available as a public API. An experimental high level C++ library is also available. -We have Python bindings of this libary, but we do not have full +We have Python bindings of this library, but we do not have full code coverage yet. Development Status @@ -490,7 +490,7 @@ disabled in the frontend and incoming HTTP/1.1 connections can be upgraded to HTTP/2 through HTTP Upgrade. The ``--http2-bridge``, ``--client`` and ``--client-proxy`` modes use -SSL/TLS in the backend connection by deafult. To disable SSL/TLS, use +SSL/TLS in the backend connection by default. To disable SSL/TLS, use the ``--backend-no-tls`` option. ``nghttpx`` supports a configuration file. See the ``--conf`` option and @@ -785,7 +785,7 @@ max_deflate_size The maximum header table size the encoder uses. This can be smaller than ``max_size``. In this case, the encoder only uses up to first ``max_deflate_size`` buffer. Since the header table size is still - ``max_size``, the encoder has to keep track of entries ouside the + ``max_size``, the encoder has to keep track of entries outside the ``max_deflate_size`` but inside the ``max_size`` and make sure that they are no longer referenced. diff --git a/doc/h2load.1 b/doc/h2load.1 index 8a59a11a..52c0428b 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -71,7 +71,7 @@ Default: \fB1\fP .INDENT 0.0 .TP .B \-i, \-\-input\-file= -Path of a file with multiple URIs are seperated by EOLs. +Path of a file with multiple URIs are separated by EOLs. This option will disable URIs getting from command\-line. If \(aq\-\(aq is given as , URIs will be read from stdin. URIs are used in this order for each client. All URIs diff --git a/doc/h2load.1.rst b/doc/h2load.1.rst index 4dae19e7..a8edea27 100644 --- a/doc/h2load.1.rst +++ b/doc/h2load.1.rst @@ -46,7 +46,7 @@ OPTIONS .. option:: -i, --input-file= - Path of a file with multiple URIs are seperated by EOLs. + Path of a file with multiple URIs are separated by EOLs. This option will disable URIs getting from command-line. If '-' is given as , URIs will be read from stdin. URIs are used in this order for each client. All URIs diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 6399cd05..4e5da161 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -812,7 +812,7 @@ argument in the configuration file. Specify \fByes\fP as an argument ignored. .sp To specify private key and certificate file which are given as -positional arguments in commnad\-line, use \fBprivate\-key\-file\fP and +positional arguments in command\-line, use \fBprivate\-key\-file\fP and \fBcertificate\-file\fP\&. .sp \fI\%\-\-conf\fP option cannot be used in the configuration file and diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index c4571d75..cdcbe019 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -727,7 +727,7 @@ FILES ignored. To specify private key and certificate file which are given as - positional arguments in commnad-line, use ``private-key-file`` and + positional arguments in command-line, use ``private-key-file`` and ``certificate-file``. :option:`--conf` option cannot be used in the configuration file and diff --git a/doc/sources/h2load-howto.rst b/doc/sources/h2load-howto.rst index 9660e07d..7c07194f 100644 --- a/doc/sources/h2load-howto.rst +++ b/doc/sources/h2load-howto.rst @@ -87,5 +87,5 @@ If multiple URIs are specified, they are used in round robin manner. .. note:: - Please note that h2load uses sheme, host and port in the first URI + Please note that h2load uses scheme, host and port in the first URI and ignores those parts in the rest of the URIs. diff --git a/doc/sources/libnghttp2_asio.rst b/doc/sources/libnghttp2_asio.rst index 85d2e01e..76999f9f 100644 --- a/doc/sources/libnghttp2_asio.rst +++ b/doc/sources/libnghttp2_asio.rst @@ -80,7 +80,7 @@ status code, in the above example, which is 200. The second argument, which is omitted in the above example, is additional header fields to send. -``nghttp2::asio_http2::server::response::end`` sends responde body. +``nghttp2::asio_http2::server::response::end`` sends response body. In the above example, we send string "hello, world". The life time of req and res object ends after the callback set by @@ -277,7 +277,7 @@ response header fields and response body to the console screen: ``boost::asio::io_service`` object and remote server address. When connection is made, the callback function passed to ``nghttp2::asio_http2::client::on_connect`` is invoked with connected -address as its paramter. After this callback call, use +address as its parameter. After this callback call, use ``nghttp2::asio_http2::session::submit`` to send request to the server. You can submit multiple requests at once without waiting for the completion of previous request. diff --git a/doc/sources/nghttpx-howto.rst b/doc/sources/nghttpx-howto.rst index 541e4a45..1f7d87e2 100644 --- a/doc/sources/nghttpx-howto.rst +++ b/doc/sources/nghttpx-howto.rst @@ -21,7 +21,7 @@ SSL/TLS, the frontend also supports SPDY protocol. By default, this mode's frontend connection is encrypted using SSL/TLS. So server's private key and certificate must be supplied to the command line (or through configuration file). In this case, the -fontend protocol selection will is done via ALPN or NPN. +frontend protocol selection will is done via ALPN or NPN. With ``--frontend-no-tls`` option, user can turn off SSL/TLS in frontend connection. In this case, SPDY protocol is not available @@ -243,7 +243,7 @@ Read/write rate limit --------------------- nghttpx supports transfer rate limiting on frontend connections. You -can do rate limit per frontend connection for reading and writeing +can do rate limit per frontend connection for reading and writing individually. To perform rate limit for reading, use ``--read-rate`` and diff --git a/doc/sources/python-apiref.rst b/doc/sources/python-apiref.rst index fd9e1111..d9d8494c 100644 --- a/doc/sources/python-apiref.rst +++ b/doc/sources/python-apiref.rst @@ -267,7 +267,7 @@ HTTP/2 servers (byte string could be ``None``), :py:data:`DATA_EOF` must be returned as flag. If there is no data available right now, but additional data are anticipated, return tuple (``None``, - :py:data:`DATA_DEFERRD`). When data arrived, call + :py:data:`DATA_DEFERRED`). When data arrived, call :py:meth:`resume()` and restart response body transmission. Only the body generator can pause response body generation; diff --git a/doc/sources/tutorial-client.rst b/doc/sources/tutorial-client.rst index 0d168991..94026323 100644 --- a/doc/sources/tutorial-client.rst +++ b/doc/sources/tutorial-client.rst @@ -65,11 +65,11 @@ its stream specific data in ``http2_stream_data`` structure and the defined as follows:: typedef struct { - /* The NULL-terminated URI string to retreive. */ + /* The NULL-terminated URI string to retrieve. */ const char *uri; /* Parsed result of the |uri| */ struct http_parser_url *u; - /* The authroity portion of the |uri|, not NULL-terminated */ + /* The authority portion of the |uri|, not NULL-terminated */ char *authority; /* The path portion of the |uri|, including query, not NULL-terminated */ @@ -204,7 +204,7 @@ transmission of client connection header is done in } Here we specify SETTINGS_MAX_CONCURRENT_STREAMS to 100, which is -really not needed for this tiny example progoram, but we are +really not needed for this tiny example program, but we are demonstrating the use of SETTINGS frame. To queue the SETTINGS frame for the transmission, we use `nghttp2_submit_settings()`. Note that `nghttp2_submit_settings()` function only queues the frame and not @@ -388,7 +388,7 @@ After all name/value pairs are emitted for a frame, } In this tutorial, we are just interested in the HTTP response -HEADERS. We check te frame type and its category (it should be +HEADERS. We check the frame type and its category (it should be :macro:`NGHTTP2_HCAT_RESPONSE` for HTTP response HEADERS). Also check its stream ID. @@ -407,7 +407,7 @@ of data is received from the remote peer:: } In our case, a chunk of data is response body. After checking stream -ID, we just write the recieved data to the stdout. Note that the +ID, we just write the received data to the stdout. Note that the output in the terminal may be corrupted if the response body contains some binary data. diff --git a/doc/sources/tutorial-hpack.rst b/doc/sources/tutorial-hpack.rst index 3bfc834d..0b4d59f1 100644 --- a/doc/sources/tutorial-hpack.rst +++ b/doc/sources/tutorial-hpack.rst @@ -51,7 +51,7 @@ bound of encoded result, use `nghttp2_hd_deflate_bound()` function:: size_t nghttp2_hd_deflate_bound(nghttp2_hd_deflater *deflater, const nghttp2_nv *nva, size_t nvlen); -Pass this function with the same paramters *deflater*, *nva* and +Pass this function with the same parameters *deflater*, *nva* and *nvlen* which will be passed to `nghttp2_hd_deflate_hd()`. The subsequent call of `nghttp2_hd_deflate_hd()` will use current From 2f2a7ace81223239aef48b5d4e3fff78e182b87e Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Tue, 12 May 2015 23:24:18 +0900 Subject: [PATCH 2/2] Fix corresponding upstream source reported in previous commits accordingly --- doc/nghttpx.h2r | 2 +- examples/libevent-client.c | 4 ++-- src/h2load.cc | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/nghttpx.h2r b/doc/nghttpx.h2r index 9f3cf66b..2d2f90d4 100644 --- a/doc/nghttpx.h2r +++ b/doc/nghttpx.h2r @@ -19,7 +19,7 @@ FILES ignored. To specify private key and certificate file which are given as - positional arguments in commnad-line, use ``private-key-file`` and + positional arguments in command-line, use ``private-key-file`` and ``certificate-file``. :option:`--conf` option cannot be used in the configuration file and diff --git a/examples/libevent-client.c b/examples/libevent-client.c index 4cda9b6f..af60fb3b 100644 --- a/examples/libevent-client.c +++ b/examples/libevent-client.c @@ -50,11 +50,11 @@ #define ARRLEN(x) (sizeof(x) / sizeof(x[0])) typedef struct { - /* The NULL-terminated URI string to retreive. */ + /* The NULL-terminated URI string to retrieve. */ const char *uri; /* Parsed result of the |uri| */ struct http_parser_url *u; - /* The authroity portion of the |uri|, not NULL-terminated */ + /* The authority portion of the |uri|, not NULL-terminated */ char *authority; /* The path portion of the |uri|, including query, not NULL-terminated */ diff --git a/src/h2load.cc b/src/h2load.cc index 8e1fa822..4c695334 100644 --- a/src/h2load.cc +++ b/src/h2load.cc @@ -1014,7 +1014,7 @@ Options: Number of native threads. Default: )" << config.nthreads << R"( -i, --input-file= - Path of a file with multiple URIs are seperated by EOLs. + Path of a file with multiple URIs are separated by EOLs. This option will disable URIs getting from command-line. If '-' is given as , URIs will be read from stdin. URIs are used in this order for each client. All URIs