From fe750240c8b96af6281d79b1a11f66bc9da4bc15 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sat, 10 Jan 2015 17:12:24 +0900 Subject: [PATCH] Update doc about nghttpx feature --- doc/h2load.1 | 2 +- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 7 ++++--- doc/nghttpx.1.rst | 5 +++-- doc/nghttpx.h2r | 5 +++-- doc/sources/nghttpx-howto.rst | 14 +++++++------- 7 files changed, 20 insertions(+), 17 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 69537faf..4778f0f4 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -141,6 +141,6 @@ Display this help and exit. .SH AUTHOR Tatsuhiro Tsujikawa .SH COPYRIGHT -2012, 2014, Tatsuhiro Tsujikawa +2012, 2015, Tatsuhiro Tsujikawa .\" Generated by docutils manpage writer. . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index eebdfcdf..77fcb70f 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -212,6 +212,6 @@ Display this help and exit. .SH AUTHOR Tatsuhiro Tsujikawa .SH COPYRIGHT -2012, 2014, Tatsuhiro Tsujikawa +2012, 2015, Tatsuhiro Tsujikawa .\" Generated by docutils manpage writer. . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 359cc033..8ad93017 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -157,6 +157,6 @@ Display this help and exit. .SH AUTHOR Tatsuhiro Tsujikawa .SH COPYRIGHT -2012, 2014, Tatsuhiro Tsujikawa +2012, 2015, Tatsuhiro Tsujikawa .\" Generated by docutils manpage writer. . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 1fe11e02..2cc76600 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -747,8 +747,9 @@ Reopen log files. .TP .B SIGUSR2 Fork and execute nghttpx. It will execute the binary in the same -path. After new process comes up, sending SIGQUIT to the original -process to perform hotswap. +path with same command\-line arguments and environment variables. +After new process comes up, sending SIGQUIT to the original process +to perform hot swapping. .UNINDENT .SH SEE ALSO .sp @@ -756,6 +757,6 @@ process to perform hotswap. .SH AUTHOR Tatsuhiro Tsujikawa .SH COPYRIGHT -2012, 2014, Tatsuhiro Tsujikawa +2012, 2015, Tatsuhiro Tsujikawa .\" Generated by docutils manpage writer. . diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index bd5d4af9..9814fab6 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -657,8 +657,9 @@ SIGUSR1 SIGUSR2 Fork and execute nghttpx. It will execute the binary in the same - path. After new process comes up, sending SIGQUIT to the original - process to perform hotswap. + path with same command-line arguments and environment variables. + After new process comes up, sending SIGQUIT to the original process + to perform hot swapping. SEE ALSO -------- diff --git a/doc/nghttpx.h2r b/doc/nghttpx.h2r index 9c458e67..ca0aeab3 100644 --- a/doc/nghttpx.h2r +++ b/doc/nghttpx.h2r @@ -19,8 +19,9 @@ SIGUSR1 SIGUSR2 Fork and execute nghttpx. It will execute the binary in the same - path. After new process comes up, sending SIGQUIT to the original - process to perform hotswap. + path with same command-line arguments and environment variables. + After new process comes up, sending SIGQUIT to the original process + to perform hot swapping. SEE ALSO -------- diff --git a/doc/sources/nghttpx-howto.rst b/doc/sources/nghttpx-howto.rst index a328d1f3..813da5eb 100644 --- a/doc/sources/nghttpx-howto.rst +++ b/doc/sources/nghttpx-howto.rst @@ -235,12 +235,12 @@ Read/write rate limit --------------------- nghttpx supports transfer rate limiting on frontend connections. You -can do rate limit per worker (thread) for reading and writeing +can do rate limit per frontend connection for reading and writeing individually. -To rate limit per worker (thread), use ``--worker-read-rate`` and -``--worker-read-burst`` options. For writing, use -``--worker-write-rate`` and ``--worker-write-burst``. +To perform rate limit for reading, use ``--read-rate`` and +``--read-burst`` options. For writing, use ``--write-rate`` and +``--write-burst``. Please note that rate limit is performed on top of TCP and nothing to do with HTTP/2 flow control. @@ -263,10 +263,10 @@ precedence. If the above conditions are not met with the host value in :authority header field, rewrite is retried with the value in host header field. -Hot deploy ----------- +Hot swapping +------------ -nghttpx supports hot deploy feature using signals. The hot deploy in +nghttpx supports hot swapping using signals. The hot swapping in nghttpx is multi step process. First send USR2 signal to nghttpx process. It will do fork and execute new executable, using same command-line arguments and environment variables. At this point, both