From 47fa56fd0a18adef9e73c63934fb709bfdadb5ef Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Tue, 14 Jun 2016 00:26:36 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 6 ++++-- doc/h2load.1.rst | 4 +++- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 16 ++++++++-------- doc/nghttpx.1.rst | 16 ++++++++-------- 6 files changed, 25 insertions(+), 21 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 2396b414..41e8891e 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2" +.TH "H2LOAD" "1" "June 14, 2016" "1.12.0-DEV" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . @@ -138,7 +138,9 @@ Default: \fBh2c\fP .TP .B \-d, \-\-data= Post FILE to server. The request method is changed to -POST. +POST. For http/1.1 connection, if \fI\%\-d\fP is used, the +maximum number of in\-flight pipelined requests is set to +1. .UNINDENT .INDENT 0.0 .TP diff --git a/doc/h2load.1.rst b/doc/h2load.1.rst index 27652644..6947f283 100644 --- a/doc/h2load.1.rst +++ b/doc/h2load.1.rst @@ -108,7 +108,9 @@ OPTIONS .. option:: -d, --data= Post FILE to server. The request method is changed to - POST. + POST. For http/1.1 connection, if :option:`-d` is used, the + maximum number of in-flight pipelined requests is set to + 1. .. option:: -r, --rate= diff --git a/doc/nghttp.1 b/doc/nghttp.1 index e8ddd3ca..ecbdc4a7 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2" +.TH "NGHTTP" "1" "June 14, 2016" "1.12.0-DEV" "nghttp2" .SH NAME nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 85113a27..652a2740 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2" +.TH "NGHTTPD" "1" "June 14, 2016" "1.12.0-DEV" "nghttp2" .SH NAME nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 40f2eba1..1a25c107 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2" +.TH "NGHTTPX" "1" "June 14, 2016" "1.12.0-DEV" "nghttp2" .SH NAME nghttpx \- HTTP/2 proxy . @@ -1733,7 +1733,7 @@ defined: The request was successful. .TP .B Failure -The request was faield. No change has been made. +The request was failed. No change has been made. .UNINDENT .TP .B code @@ -1745,13 +1745,13 @@ some cases where the error has occurred before reaching API endpoint (e.g., header field is too large). .sp The following section describes available API endpoints. -.SS PUT /api/v1beta1/backend/replace +.SS PUT /api/v1beta1/backendconfig .sp -This API replaces the current set of backend servers with the -requested ones. The request must carry request body with method PUT -or POST. The request body must be nghttpx configuration file format. -For configuration file format, see \fI\%FILES\fP section. The line -separator inside the request body must be single LF (0x0A). +This API replaces the current backend server settings with the +requested ones. The request method should be PUT, but POST is also +acceptable. The request body must be nghttpx configuration file +format. For configuration file format, see \fI\%FILES\fP section. The +line separator inside the request body must be single LF (0x0A). Currently, only \fI\%backend\fP option is parsed, the others are simply ignored. The semantics of this API is replace the current backend with the backend options in request body. Describe diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index 300b2236..d1f8d67e 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -1574,7 +1574,7 @@ status The request was successful. Failure - The request was faield. No change has been made. + The request was failed. No change has been made. code HTTP status code @@ -1585,14 +1585,14 @@ some cases where the error has occurred before reaching API endpoint The following section describes available API endpoints. -PUT /api/v1beta1/backend/replace -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +PUT /api/v1beta1/backendconfig +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This API replaces the current set of backend servers with the -requested ones. The request must carry request body with method PUT -or POST. The request body must be nghttpx configuration file format. -For configuration file format, see `FILES`_ section. The line -separator inside the request body must be single LF (0x0A). +This API replaces the current backend server settings with the +requested ones. The request method should be PUT, but POST is also +acceptable. The request body must be nghttpx configuration file +format. For configuration file format, see `FILES`_ section. The +line separator inside the request body must be single LF (0x0A). Currently, only :option:`backend <--backend>` option is parsed, the others are simply ignored. The semantics of this API is replace the current backend with the backend options in request body. Describe