]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Docs: shuffle SMP specific options to the top of squid.conf
authorAmos Jeffries <squid3@treenet.co.nz>
Sat, 9 May 2015 11:48:35 +0000 (04:48 -0700)
committerAmos Jeffries <squid3@treenet.co.nz>
Sat, 9 May 2015 11:48:35 +0000 (04:48 -0700)
The workers directive is required to be used before several other
directives. It makes little sense to documents it after the controls
which depend on it.

Make a new config section to contain the SMP specific options.

src/cf.data.pre

index 8e7e0207b857860eb088be6a4f78927327d58e22..20f9841954a949d342d8f25933e29429220c4db6 100644 (file)
@@ -321,6 +321,49 @@ DOC_START
        Replace this line with 'cache_peer' configuration.
 DOC_END
 
+COMMENT_START
+ OPTIONS FOR SMP
+ -----------------------------------------------------------------------------
+COMMENT_END
+
+NAME: workers
+TYPE: int
+LOC: Config.workers
+DEFAULT: 1
+DEFAULT_DOC: SMP support disabled.
+DOC_START
+       Number of main Squid processes or "workers" to fork and maintain.
+       0: "no daemon" mode, like running "squid -N ..."
+       1: "no SMP" mode, start one main Squid process daemon (default)
+       N: start N main Squid process daemons (i.e., SMP mode)
+
+       In SMP mode, each worker does nearly all what a single Squid daemon
+       does (e.g., listen on http_port and forward HTTP requests).
+DOC_END
+
+NAME: cpu_affinity_map
+TYPE: CpuAffinityMap
+LOC: Config.cpuAffinityMap
+DEFAULT: none
+DEFAULT_DOC: Let operating system decide.
+DOC_START
+       Usage: cpu_affinity_map process_numbers=P1,P2,... cores=C1,C2,...
+
+       Sets 1:1 mapping between Squid processes and CPU cores. For example,
+
+           cpu_affinity_map process_numbers=1,2,3,4 cores=1,3,5,7
+
+       affects processes 1 through 4 only and places them on the first
+       four even cores, starting with core #1.
+
+       CPU cores are numbered starting from 1. Requires support for
+       sched_getaffinity(2) and sched_setaffinity(2) system calls.
+
+       Multiple cpu_affinity_map options are merged.
+
+       See also: workers
+DOC_END
+
 COMMENT_START
  OPTIONS FOR AUTHENTICATION
  -----------------------------------------------------------------------------
@@ -9259,42 +9302,33 @@ DOC_START
        not all I/O types supports large values (eg on Windows).
 DOC_END
 
-NAME: workers
-TYPE: int
-LOC: Config.workers
-DEFAULT: 1
-DEFAULT_DOC: SMP support disabled.
-DOC_START
-       Number of main Squid processes or "workers" to fork and maintain.
-       0: "no daemon" mode, like running "squid -N ..."
-       1: "no SMP" mode, start one main Squid process daemon (default)
-       N: start N main Squid process daemons (i.e., SMP mode)
-
-       In SMP mode, each worker does nearly all what a single Squid daemon
-       does (e.g., listen on http_port and forward HTTP requests).
-DOC_END
-
-NAME: cpu_affinity_map
-TYPE: CpuAffinityMap
-LOC: Config.cpuAffinityMap
+NAME: force_request_body_continuation
+TYPE: acl_access
+LOC: Config.accessList.forceRequestBodyContinuation
 DEFAULT: none
-DEFAULT_DOC: Let operating system decide.
+DEFAULT_DOC: Deny, unless rules exist in squid.conf.
 DOC_START
-       Usage: cpu_affinity_map process_numbers=P1,P2,... cores=C1,C2,...
-
-       Sets 1:1 mapping between Squid processes and CPU cores. For example,
-
-           cpu_affinity_map process_numbers=1,2,3,4 cores=1,3,5,7
-
-       affects processes 1 through 4 only and places them on the first
-       four even cores, starting with core #1.
-
-       CPU cores are numbered starting from 1. Requires support for
-       sched_getaffinity(2) and sched_setaffinity(2) system calls.
-
-       Multiple cpu_affinity_map options are merged.
-
-       See also: workers
+       This option controls how Squid handles data upload requests from HTTP
+       and FTP agents that require a "Please Continue" control message response
+       to actually send the request body to Squid. It is mostly useful in
+       adaptation environments.
+       
+       When Squid receives an HTTP request with an "Expect: 100-continue"
+       header or an FTP upload command (e.g., STOR), Squid normally sends the
+       request headers or FTP command information to an adaptation service (or
+       peer) and waits for a response. Most adaptation services (and some
+       broken peers) may not respond to Squid at that stage because they may
+       decide to wait for the HTTP request body or FTP data transfer. However,
+       that request body or data transfer may never come because Squid has not
+       responded with the HTTP 100 or FTP 150 (Please Continue) control message
+       to the request sender yet!
+       
+       An allow match tells Squid to respond with the HTTP 100 or FTP 150
+       (Please Continue) control message on its own, before forwarding the
+       request to an adaptation service or peer. Such a response usually forces
+       the request sender to proceed with sending the body. A deny match tells
+       Squid to delay that control response until the origin server confirms
+       that the request body is needed. Delaying is the default behavior.
 DOC_END
 
 EOF