You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@httpd.apache.org by bu...@apache.org on 2010/12/06 15:33:47 UTC

DO NOT REPLY [Bug 50417] New: miscellaneous clarification for the mod_autoindex documentation

https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

           Summary: miscellaneous clarification for the mod_autoindex
                    documentation
           Product: Apache httpd-2
           Version: 2.3-HEAD
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: enhancement
          Priority: P2
         Component: Documentation
        AssignedTo: docs@httpd.apache.org
        ReportedBy: calestyo@scientia.net


May I suggest the following clarifications for the mod_autoindex documentation
(I could provide patches if you like):

1) For all AddIcon* directives:
The URL does not have to be a relative URL, it can also be an absolute which
makes sense if it's on external server.

2) It should be mentioned that a ^^BLANKICON^^ is only required (and suggested)
if one doesn't us HTMLTable.

3) It should be suggested to add ".ht*" to IndexIgnore. Although these files
wouldn't be displayed (if access was denied because of "-ShowForbidden" each
listing would cause errors like:
"client denied by server configuration: /var/www/.htaccess"

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

Christoph Anton Mitterer <ca...@scientia.net> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|RESOLVED                    |REOPENED
         Resolution|FIXED                       |

--- Comment #10 from Christoph Anton Mitterer <ca...@scientia.net> 2011-01-16 11:28:03 EST ---
Hi Rich.

Thanks for all the changes,... looked them up and I'm quite happy with them,
except perhaps the
IndexIgnore .??*

IMHO the default example (and also the docs) should be changed from ".??*" to
".ht*", whit the reason, that there is (IMO) not reason to ignore/prohibit more
than necessary.
".??*" would ignore/prohibit all dot-files having at least two characters...
why should we do this?

(reopening therefore, if you do not agree,.. simply close it :) )

Cheers,
Chris.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

Rich Bowen <rb...@apache.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|REOPENED                    |RESOLVED
         Resolution|                            |FIXED

--- Comment #12 from Rich Bowen <rb...@apache.org> 2011-07-21 13:26:50 UTC ---
Yes, I agree with Daniel's assessment here, and believe that we should continue
to hide, and recommend hiding, all "dot files". It is what people have come to
expect, and it's a convention for hiding files in the Unix world, as Daniel
says.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

Rich Bowen <rb...@apache.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|                            |FIXED

--- Comment #8 from Rich Bowen <rb...@apache.org> 2011-01-16 10:34:37 EST ---
(In reply to comment #2)
> 5) The following directives should list their defaults:
> IndexIgnore: "."
> IndexOptions: is there any default?

Defaults provided in r1059584

This ticket is now resolved. Note that these changes have all been made in
trunk docs, and have not been backported to 2.2 or 2.0. If someone would like
to compile a patch and/or merge those changes back to those branches, please go
right ahead.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

--- Comment #9 from Rich Bowen <rb...@apache.org> 2011-01-16 10:59:48 EST ---
Never mind. I went ahead and pushed it back to 2.0 and 2.2

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

--- Comment #7 from Rich Bowen <rb...@apache.org> 2011-01-16 10:31:25 EST ---
(In reply to comment #1)
> 4) At http://httpd.apache.org/docs/2.2/mod/mod_autoindex.html#indexorderdefault
> "You can force a directory listing to only be displayed in a particular order
> by combining this directive with the SuppressColumnSorting index option; this
> will prevent the client from requesting the directory listing in a different
> order."
> ... seems to be outdated information, as SuppressColumnSorting contains only
> whether the headers are links or not nowadays.
> That must be replaced with IgnoreClient option IMHO

Rephrased in r1059582

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

Daniel Ruggeri <DR...@primary.net> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |DRuggeri@primary.net

--- Comment #11 from Daniel Ruggeri <DR...@primary.net> 2011-01-16 14:35:39 EST ---
In the UNIX world, files beginning with a dot are what would be considered
"hidden" files a la the Windows world. I would contend that the example ought
to exclude any file beginning with a dot - however many characters long the
file is.

IMO, I think that is the intention of this particular example.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

--- Comment #2 from Christoph Anton Mitterer <ca...@scientia.net> 2010-12-06 17:16:06 EST ---
5) The following directives should list their defaults:
IndexIgnore: "."
IndexOptions: is there any default?

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

--- Comment #3 from Rich Bowen <rb...@apache.org> 2011-01-16 08:57:37 EST ---

> 1) For all AddIcon* directives:
> The URL does not have to be a relative URL, it can also be an absolute which
> makes sense if it's on external server.

Done, r1059559

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

--- Comment #6 from Rich Bowen <rb...@apache.org> 2011-01-16 10:19:56 EST ---
(In reply to comment #1)
> 4) At http://httpd.apache.org/docs/2.2/mod/mod_autoindex.html#indexorderdefault
> "You can force a directory listing to only be displayed in a particular order
> by combining this directive with the SuppressColumnSorting index option; this
> will prevent the client from requesting the directory listing in a different
> order."
> ... seems to be outdated information, as SuppressColumnSorting contains only
> whether the headers are links or not nowadays.
> That must be replaced with IgnoreClient option IMHO

Sort of. Ignoring the client's preferences is a two-part thing. You must
SuppressColumnSorting to remove the sort link at the top of the column, and
also IgnoreClient to prevent them just putting the sort arguments directly in
the query string.

However, I think that this paragraph is just phrased wrong. This directive is
for setting a *default* sort order. The decision to not let the client reorder
is a separate thing, and we shouldn't imply that it's necessary in order to set
a default ordering. Will rephrase accordingly.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

--- Comment #1 from Christoph Anton Mitterer <ca...@scientia.net> 2010-12-06 12:48:26 EST ---
4) At http://httpd.apache.org/docs/2.2/mod/mod_autoindex.html#indexorderdefault
"You can force a directory listing to only be displayed in a particular order
by combining this directive with the SuppressColumnSorting index option; this
will prevent the client from requesting the directory listing in a different
order."
... seems to be outdated information, as SuppressColumnSorting contains only
whether the headers are links or not nowadays.
That must be replaced with IgnoreClient option IMHO

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

--- Comment #5 from Rich Bowen <rb...@apache.org> 2011-01-16 09:11:13 EST ---
> 3) It should be suggested to add ".ht*" to IndexIgnore. Although these files
> wouldn't be displayed (if access was denied because of "-ShowForbidden" each
> listing would cause errors like:
> "client denied by server configuration: /var/www/.htaccess"

The default configuration file contains:

IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t

That first one - .??* - covers .ht* and many other files that one would like to
hide.

Every third-party distro that I've looked at also includes something like this
in the default. Also, the example in the docs included .htaccess.

However, what I've done in r1059562 is make the example given in the docs match
the example in the default config file provided at
conf/extra/httpd-autoindex.conf, which is as shown above.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


DO NOT REPLY [Bug 50417] miscellaneous clarification for the mod_autoindex documentation

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50417

--- Comment #4 from Rich Bowen <rb...@apache.org> 2011-01-16 09:03:39 EST ---

> 2) It should be mentioned that a ^^BLANKICON^^ is only required (and suggested)
> if one doesn't us HTMLTable.


I've added a note to this effect in r1059561 although I haven't made it quite
as strong as you infer. BLANKICON isn't needed if you're using HTMLTable, but
it certainly doesn't hurt anything to have it. It's simply not used.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org