documentation/6070: Minor documentation omission about DocumentRoot in httpd.conf

[Eric Maryniak <e....@pobox.com>]

>Number:         6070
>Category:       documentation
>Synopsis:       Minor documentation omission about DocumentRoot in httpd.conf
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    apache
>State:          open
>Class:          doc-bug
>Submitter-Id:   apache
>Arrival-Date:   Thu May 11 03:30:01 PDT 2000
>Closed-Date:
>Last-Modified:
>Originator:     e.maryniak@pobox.com
>Release:        1.3.9
>Organization:
apache
>Environment:
SuSE Linux 6.3
>Description:
The #commented docu about DocumentRoot in the 'default' httpd.conf
describes DocumentRoot as:
===
# DocumentRoot: The directory out of which you will serve your
# documents. By default, all requests are taken from this directory, but
# symbolic links and aliases may be used to point to other locations.
===
This is not entirely accurate imho, because (at least on SuSE Linux 6.3)
symlinks are _not_ followed by default, because of a:
<Directory />
    Options -FollowSymLinks ...
...
</Directory>
>How-To-Repeat:
N/A.
>Fix:
I would change the phrasing to:
===
# DocumentRoot: The directory out of which you will serve your
# documents. By default, all requests are taken from this directory.
# Symbolic links, unless disabled by a 'Options -FollowSymLinks', and
# aliases may be used to point to other locations.
===
>Release-Note:
>Audit-Trail:
>Unformatted:
 [In order for any reply to be added to the PR database, you need]
 [to include <ap...@Apache.Org> in the Cc line and make sure the]
 [subject line starts with the report component and number, with ]
 [or without any 'Re:' prefixes (such as "general/1098:" or      ]
 ["Re: general/1098:").  If the subject doesn't match this       ]
 [pattern, your message will be misfiled and ignored.  The       ]
 ["apbugs" address is not added to the Cc line of messages from  ]
 [the database automatically because of the potential for mail   ]
 [loops.  If you do not include this Cc, your reply may be ig-   ]
 [nored unless you are responding to an explicit request from a  ]
 [developer.  Reply only with text; DO NOT SEND ATTACHMENTS!     ]