Bug 60404 - Unclear documentation about TimeOut directive for CGI
Summary: Unclear documentation about TimeOut directive for CGI
Status: RESOLVED FIXED
Alias: None
Product: Apache httpd-2
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 2.4.10
Hardware: PC Linux
: P2 normal (vote)
Target Milestone: ---
Assignee: HTTP Server Documentation List
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-11-22 19:24 UTC by Victor Porton
Modified: 2020-09-04 03:29 UTC (History)
0 users



Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Victor Porton 2016-11-22 19:24:39 UTC
http://httpd.apache.org/docs/2.4/mod/core.html#timeout

"In mod_cgi, the length of time to wait for output from a CGI script."

It is unclear whether it is about the time until the CGI script closes stdout or about the time until the first character from the CGI output appears.

Please make your documentation more clear.
Comment 1 Luca Toscano 2017-01-30 12:59:18 UTC
Hi Victor,

I updated https://httpd.apache.org/docs/trunk/mod/core.html#timeout, I believe the answer is the first byte received not the whole output. Going to wait for a bit of feedback before updating 2.4's documentation too.

Thanks!

Luca
Comment 2 Luca Toscano 2017-01-30 15:01:13 UTC
After some feedback the description is now a very simple:

"In mod_cgi (and mod_cgid), the length of time to wait for any individual block of output from a CGI script."

So the timeout is not only for the first byte emitted, but also the maximum allowed time between blocks of bytes returned by the CGI script.

Let me know if it is clear enough or if it needs a better explanation :)

Luca
Comment 3 Luca Toscano 2017-01-31 09:49:27 UTC
2.4 documentation updated, please re-open the task if anything is missing or the documentation is still unclear.

Thanks!
Comment 4 dcook 2020-09-04 03:29:02 UTC
I think the documentation might actually be incorrect for mod_cgi, but I'm going to be opening a bug report about that shortly...