----- Original Message ----- > Updated Branches: > refs/heads/master 53ae4b950 -> 8ecd7e66c > > > Documentation: Fixed a few warnings. > > > Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo > Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/8ecd7e66 > Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/8ecd7e66 > Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/8ecd7e66 > > Branch: refs/heads/master > Commit: 8ecd7e66c5106c06023b2e83706d3d04b0aa9934 > Parents: 53ae4b9 > Author: Alan M. Carroll <a...@network-geographics.com> > Authored: Fri Aug 9 11:36:16 2013 -0500 > Committer: Alan M. Carroll <a...@network-geographics.com> > Committed: Fri Aug 9 11:36:16 2013 -0500 > > ---------------------------------------------------------------------- > doc/ext/traffic-server.py | 4 + > doc/reference/configuration/cache.config.en.rst | 118 +++++++++---------- > .../configuration/plugin.config.en.rst | 28 ++--- > doc/reference/plugins/metafilter.en.rst | 4 +- > 4 files changed, 78 insertions(+), 76 deletions(-) > ---------------------------------------------------------------------- > > > http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ecd7e66/doc/ext/traffic-server.py > ---------------------------------------------------------------------- > diff --git a/doc/ext/traffic-server.py b/doc/ext/traffic-server.py > index 5ce8371..2a978f2 100644 > --- a/doc/ext/traffic-server.py > +++ b/doc/ext/traffic-server.py > @@ -154,3 +154,7 @@ def setup(app): > objname='Configuration file', > indextemplate='pair: %s; Configuration files') > app.add_domain(TrafficServerDomain) > + > + # Types that we want the C domain to consider built in > + for word in ('size_t'): > + sphinx.domains.c.CObject.stopwords.add(word) > > http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ecd7e66/doc/reference/configuration/cache.config.en.rst > ---------------------------------------------------------------------- > diff --git a/doc/reference/configuration/cache.config.en.rst > b/doc/reference/configuration/cache.config.en.rst > index 042a048..00a6bf2 100644 > --- a/doc/reference/configuration/cache.config.en.rst > +++ b/doc/reference/configuration/cache.config.en.rst > @@ -1,19 +1,19 @@ > .. 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 > - > + 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. > + > + 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. > > ============ > cache.config > @@ -29,11 +29,11 @@ no-cache directives from the server > > .. important:: > > - After you modify the :file:`cache.config file`, navigate to > - the Traffic Server bin directory; then run the :option:`traffic_line -x` > - command to apply changes. When you apply the changes to a node in a > - cluster, Traffic Server automatically applies the changes to all other > - nodes in the cluster. > + After you modify the :file:`cache.config` file, navigate to > + the Traffic Server bin directory; then run the :option:`traffic_line -x` > + command to apply changes. When you apply the changes to a node in a > + cluster, Traffic Server automatically applies the changes to all other > + nodes in the cluster. > > Format > ====== > @@ -41,83 +41,83 @@ Format > Each line in the :file:`cache.config` file contains a caching rule. Traffic > Server recognizes three space-delimited tags:: > > - primary_destination=value secondary_specifier=value action=value > + primary_destination=value secondary_specifier=value action=value > > You can use more than one secondary specifier in a rule. However, you > cannot repeat a secondary specifier. The following list shows the > possible primary destinations with allowed values. > > *``dest_domain``* {#dest_domain} > - A requested domain name. Traffic Server matches the domain name of > - the destination from the URL in the request. > + A requested domain name. Traffic Server matches the domain name of > + the destination from the URL in the request.
should we generalize ts:cv to extend it to other configs? > *``dest_host``* {#dest_host} > - A requested hostname. Traffic Server matches the hostname of the > - destination from the URL in the request. > + A requested hostname. Traffic Server matches the hostname of the > + destination from the URL in the request. > > *``dest_ip``* {#dest_ip} > - A requested IP address. Traffic Server matches the IP address of the > - destination in the request. > + A requested IP address. Traffic Server matches the IP address of the > + destination in the request. > > *``url_regex``* {#url_regex} > - A regular expression (regex) to be found in a URL. > + A regular expression (regex) to be found in a URL. > > The secondary specifiers are optional in the :file:`cache.config` file. The > following list shows possible secondary specifiers with allowed values. > > *``port``* {#port} > - A requested URL port. > + A requested URL port. > > *``scheme``* {#scheme} > - A request URL protocol: http or https. > + A request URL protocol: http or https. > > *``prefix``* {#prefix} > - A prefix in the path part of a URL. > + A prefix in the path part of a URL. > > *``suffix``* {#suffix} > - A file suffix in the URL. > + A file suffix in the URL. > > *``method``* {#method} > - A request URL method: get, put, post, trace. > + A request URL method: get, put, post, trace. > > *``time``* {#time} > - A time range, such as 08:00-14:00. > + A time range, such as 08:00-14:00. > > *``src_ip``* {#src_ip} > - A client IP address. > + A client IP address. > > The following list shows possible actions and their allowed values. > > *``action``* {#action} > - One of the following values: > + One of the following values: > > - - ``never-cache`` configures Traffic Server to never cache > - specified objects. > - - ``ignore-no-cache`` configures Traffic Server to ignore all > - ``Cache-Control: no-cache`` headers. > - - ``ignore-client-no-cache`` configures Traffic Server to ignore > - ``Cache-Control: no-cache`` headers from client requests. > - - ``ignore-server-no-cache`` configures Traffic Server to ignore > - ``Cache-Control: no-cache`` headers from origin server responses. > + - ``never-cache`` configures Traffic Server to never cache > + specified objects. > + - ``ignore-no-cache`` configures Traffic Server to ignore all > + ``Cache-Control: no-cache`` headers. > + - ``ignore-client-no-cache`` configures Traffic Server to ignore > + ``Cache-Control: no-cache`` headers from client requests. > + - ``ignore-server-no-cache`` configures Traffic Server to ignore > + ``Cache-Control: no-cache`` headers from origin server responses. > > *``pin-in-cache``* {#pin-in-cache} > - The amount of time you want to keep the object(s) in the cache. The > - following time formats are allowed: > + The amount of time you want to keep the object(s) in the cache. The > + following time formats are allowed: > > - - ``d`` for days; for example: 2d > - - ``h`` for hours; for example: 10h > - - ``m`` for minutes; for example: 5m > - - ``s`` for seconds; for example: 20s > - - mixed units; for example: 1h15m20s > + - ``d`` for days; for example: 2d > + - ``h`` for hours; for example: 10h > + - ``m`` for minutes; for example: 5m > + - ``s`` for seconds; for example: 20s > + - mixed units; for example: 1h15m20s > > *``revalidate``* {#revalidate} > - The amount of time object(s) are to be considered fresh. Use the > - same time formats as ``pin-in-cache``. > + The amount of time object(s) are to be considered fresh. Use the > + same time formats as ``pin-in-cache``. > > *``ttl-in-cache``* {#ttl-in-cache} > - The amount of time object(s) are to be kept in the cache, regardless > - of Cache-Control response headers. Use the same time formats as > - pin-in-cache and revalidate . > + The amount of time object(s) are to be kept in the cache, regardless > + of Cache-Control response headers. Use the same time formats as > + pin-in-cache and revalidate . > > Examples > ======== > @@ -125,11 +125,9 @@ Examples > The following example configures Traffic Server to revalidate ``gif`` > and ``jpeg`` objects in the domain ``mydomain.com`` every 6 hours, and > all other objects in ``mydomain.com`` every hour. The rules are applied > -in the order listed. > - > -:: > +in the order listed. :: > > - dest_domain=mydomain.com suffix=gif revalidate=6h > - dest_domain=mydomain.com suffix=jpeg revalidate=6h > - dest_domain=mydomain.com revalidate=1h > + dest_domain=mydomain.com suffix=gif revalidate=6h > + dest_domain=mydomain.com suffix=jpeg revalidate=6h > + dest_domain=mydomain.com revalidate=1h > > > http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ecd7e66/doc/reference/configuration/plugin.config.en.rst > ---------------------------------------------------------------------- > diff --git a/doc/reference/configuration/plugin.config.en.rst > b/doc/reference/configuration/plugin.config.en.rst > index 9a5afa6..7add8b2 100644 > --- a/doc/reference/configuration/plugin.config.en.rst > +++ b/doc/reference/configuration/plugin.config.en.rst > @@ -1,19 +1,19 @@ > .. 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. > + 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. > > ============= > plugin.config > > http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ecd7e66/doc/reference/plugins/metafilter.en.rst > ---------------------------------------------------------------------- > diff --git a/doc/reference/plugins/metafilter.en.rst > b/doc/reference/plugins/metafilter.en.rst > index 7c75157..0061341 100644 > --- a/doc/reference/plugins/metafilter.en.rst > +++ b/doc/reference/plugins/metafilter.en.rst > @@ -26,7 +26,7 @@ Take standard headers and knowledge about objects in the > cache and > potentially rewrite those headers so that a client will use a URL > that is already cached instead of one that isn't. > > -The `metalink` headers are specified in :rfc:`6429` and :rfc:`3230` > +The `metalink` headers are specified in :rfc:`6429` and :rfc:`3230` > and are sent by various download redirectors or content distribution > networks. > > @@ -59,7 +59,7 @@ Installation > ------------ > > `metalink` is a global plugin. It is enabled by adding it to your > -:file:`plugins.config` file. There are no options. > +:file:`plugin.config` file. There are no options. > > Implementation Status > --------------------- > > -- Igor Galić Tel: +43 (0) 664 886 22 883 Mail: i.ga...@brainsware.org URL: http://brainsware.org/ GPG: 6880 4155 74BD FD7C B515 2EA5 4B1D 9E08 A097 C9AE