Commit e768db99 authored by Yann Ylavic's avatar Yann Ylavic
Browse files

Merge r1793922, r1793923 from trunk: 

Add an Override Class Index

This page pulls in directives that declare an <override> element and
groups them by class. The documentation for each class comes from
overrides.xml. Any undocumented classes are flagged with a boilerplate
fallback text (this situation is only likely to occur with a misspelling
or otherwise invalid <override> somewhere else in the documentation).

override index: clarify this doc's purpose

Based on feedback by elukey.
Submitted by: jchampion
Reviewed by: jchampion, jim, icing


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1807765 13f79535-47bb-0310-9956-ffa450edef68
parent 655bee2c

STATUS

+0 −9
Original line number Diff line number Diff line
@@ -131,15 +131,6 @@ PATCHES ACCEPTED TO BACKPORT FROM TRUNK: 
     2.4.x patch: http://home.apache.org/~jim/patches/httpd-2.4-hcheck-ms.patch

     +1: jim, covener, ylavic



  *) docs: add an auto-generated Overrides class index.

           (I know this is technically CTR, but the new machinery is a little

           more complex than just a simple docs change. Make sure to svn-up your

           docs-build directory.)

     trunk patch: https://svn.apache.org/r1793922

                  https://svn.apache.org/r1793923

     2.4.x patch: svn merge -r1793921:HEAD ^/httpd/httpd/branches/trunk-override-index

     +1: jchampion, jim, icing



  *) mod_proxy: Name the scheme in the error message when the 

     mod_proxy_foo submodule is missing.

     trunk patch: http://svn.apache.org/r1745039

docs/manual/index.xml

+1 −0
Original line number Diff line number Diff line
@@ -44,6 +44,7 @@ Documentation</title> 
    <page href="filter.html">Filters</page>

    <page href="handler.html">Handlers</page>

    <page href="expr.html">Expression parser</page>

    <page href="mod/overrides.html">Override Class Index for .htaccess</page>

    <page href="programs/">Server and Supporting Programs</page>

    <page href="glossary.html">Glossary</page>

</category>

docs/manual/mod/core.xml

+9 −6
Original line number Diff line number Diff line
@@ -345,10 +345,12 @@ NoDecode option available in 2.3.12 and later.</compatibility> 
    <code>.htaccess</code> files.</p>



    <p>The <var>directive-type</var> can be one of the following

    groupings of directives.</p>

    groupings of directives. (See the <a href="overrides.html">override class

    index</a> for an up-to-date listing of which directives are enabled by each

    <var>directive-type</var>.)</p>



    <dl>

      <dt>AuthConfig</dt>

      <dt><a href="overrides.html#override-authconfig">AuthConfig</a></dt>



      <dd>
@@ -361,7 +363,7 @@ NoDecode option available in 2.3.12 and later.</compatibility> 
      module="mod_authn_file">AuthUserFile</directive>, <directive

      module="mod_authz_core">Require</directive>, <em>etc.</em>).</dd>



      <dt>FileInfo</dt>

      <dt><a href="overrides.html#override-fileinfo">FileInfo</a></dt>



      <dd>

      Allow use of the directives controlling document types
@@ -398,7 +400,7 @@ NoDecode option available in 2.3.12 and later.</compatibility> 
      <module>mod_actions</module>.

      </dd>



      <dt>Indexes</dt>

      <dt><a href="overrides.html#override-indexes">Indexes</a></dt>



      <dd>

      Allow use of the directives controlling directory indexing
@@ -416,7 +418,7 @@ NoDecode option available in 2.3.12 and later.</compatibility> 
      module="mod_autoindex">ReadmeName</directive>,

      <em>etc.</em>).</dd>



      <dt>Limit</dt>

      <dt><a href="overrides.html#override-limit">Limit</a></dt>



      <dd>

      Allow use of the directives controlling host access (<directive
@@ -448,7 +450,7 @@ NoDecode option available in 2.3.12 and later.</compatibility> 
      </note>

      </dd>



      <dt>Options[=<var>Option</var>,...]</dt>

      <dt><a href="overrides.html#override-options">Options</a>[=<var>Option</var>,...]</dt>



      <dd>

      Allow use of the directives controlling specific directory
@@ -495,6 +497,7 @@ AllowOverride AuthConfig Indexes 
<seealso><directive module="core">AllowOverrideList</directive></seealso>

<seealso><a href="../configuring.html">Configuration Files</a></seealso>

<seealso><a href="../howto/htaccess.html">.htaccess Files</a></seealso>

<seealso><a href="overrides.html">Override Class Index for .htaccess</a></seealso>

</directivesynopsis>



<directivesynopsis>

docs/manual/mod/overrides.xml

0 → 100644
+141 −0
Original line number Diff line number Diff line 
<?xml version="1.0"?>

<!DOCTYPE overrideindex SYSTEM "../style/modulesynopsis.dtd">

<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>

<!-- $LastChangedRevision$ -->



<!--

 Licensed to the Apache Software Foundation (ASF) under one or more

 contributor license agreements.  See the NOTICE file distributed with

 this work for additional information regarding copyright ownership.

 The ASF licenses this file to You under the Apache License, Version 2.0

 (the "License"); you may not use this file except in compliance with

 the License.  You may obtain a copy of the License at



     http://www.apache.org/licenses/LICENSE-2.0



 Unless required by applicable law or agreed to in writing, software

 distributed under the License is distributed on an "AS IS" BASIS,

 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 See the License for the specific language governing permissions and

 limitations under the License.

-->



<overrideindex metafile="overrides.xml.meta">

  <title>Override Class Index for .htaccess</title>

  <summary>

    <p>

      This is an index of the directives that are allowed in .htaccess files for

      various <directive module="core">AllowOverride</directive> settings,

      organized by class. Its intended purpose is to help server administrators

      verify the privileges they're granting to .htaccess users. For an overview

      of how .htaccess works, see the

      <a href="../howto/htaccess.html">.htaccess tutorial</a>.

    </p>



    <p>

      To determine the set of directives that your server configuration allows

      .htaccess users to use:

    </p>



    <ol>

      <li>Start with the set of directives in the <code>AllowOverrideList</code>

      for the directory in question. (By default, this is set to

      <code>None</code>.)</li>

      <li>Find the <code>AllowOverride</code> setting for the directory in

      question. (By default, it is set to <code>None</code>.) There are two

      special cases:

        <ol>

          <li>If your <code>AllowOverride</code> setting is <code>All</code>,

          add every directive listed on this page to the list.</li>

          <li>If your <code>AllowOverride</code> setting is <code>None</code>,

          you're done. Only the directives in the <code>AllowOverrideList</code>

          (if any) will be allowed.</li>

        </ol>

      </li>

      <li>For each override class listed in <code>AllowOverride</code>, look up

      the corresponding set of directives below and add them to the list.</li>

      <li>Finally, add the set of directives that is always allowed in

      .htaccess (these are listed in the

      <a href="#override-all">All section</a>, below).</li>

    </ol>



    <p>

      Several of the override classes are quite powerful and give .htaccess

      users a large amount of control over the server. For a stricter approach,

      set <code>AllowOverride None</code> and use

      <directive module="core">AllowOverrideList</directive> to specify the

      exact list of directives that .htaccess users are allowed to use.

    </p>

  </summary>



  <!--

    Provide one overridesummary element for each Override type. The content will

    be sucked into the relevant section on the override index page.

  -->



  <overridesummary class="All">

    <p>

      The following directives are allowed in any .htaccess file, as long as

      overrides are enabled in the server configuration.

    </p>

  </overridesummary>



  <overridesummary class="AuthConfig">

    <p>

      The following directives are allowed in .htaccess files when

      <code>AllowOverride AuthConfig</code> is in effect. They give .htaccess

      users control over the authentication and authorization methods that are

      applied to their directory subtrees, including several related utility

      directives for session handling and TLS settings.

    </p>

  </overridesummary>



  <overridesummary class="FileInfo">

    <p>

      The following directives are allowed in .htaccess files when

      <code>AllowOverride FileInfo</code> is in effect. They give .htaccess

      users a wide range of control over the responses and metadata given by the

      server.

    </p>

  </overridesummary>



  <overridesummary class="Indexes">

    <p>

      The following directives are allowed in .htaccess files when

      <code>AllowOverride Indexes</code> is in effect. They allow .htaccess

      users to control aspects of the directory index pages provided by the

      server, including autoindex generation.

    </p>

  </overridesummary>



  <overridesummary class="Limit">

    <p>

      The following directives are allowed in .htaccess files when

      <code>AllowOverride Limit</code> is in effect. This extremely narrow

      override type mostly allows the use of the legacy authorization directives

      provided by <module>mod_access_compat</module>.

    </p>

  </overridesummary>



  <overridesummary class="Options">

    <p>

      The following directives are allowed in .htaccess files when

      <code>AllowOverride Options</code> is in effect. They give .htaccess

      users access to <code>Options</code> and similar directives, as well as

      directives that control the filter chain.

    </p>

  </overridesummary>



  <!--

    This is the error message for when a directive shows up in a section that

    has no explicit overridesummary above.

  -->

  <overridesummary fallback="yes">

    <p><em>

    [This section has no description. It's possible that the documentation is

    incomplete, or that the directives here have an incorrect or misspelled

    Override type. Please consider reporting this in the

    <a href="#comments_section">comments section</a>.]

    </em></p>

  </overridesummary>

</overrideindex>

docs/manual/sitemap.xml

+1 −0
Original line number Diff line number Diff line
@@ -191,6 +191,7 @@ log_server_status</page> 
<page href="mod/">Module index</page>

<page href="mod/directives.html">Directive index</page>

<page href="mod/quickreference.html">Directive Quick-Reference</page>

<page href="mod/overrides.html">Override class index for .htaccess</page>

</category>



</sitemap>