You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by am...@apache.org on 2015/06/18 04:02:13 UTC
trafficserver git commit: Doc: various updates. This closes #191.
Repository: trafficserver
Updated Branches:
refs/heads/master 62d9afa41 -> f7cbf4685
Doc: various updates.
This closes #191.
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/f7cbf468
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/f7cbf468
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/f7cbf468
Branch: refs/heads/master
Commit: f7cbf4685439e567805b3df8553d3efc7925634c
Parents: 62d9afa
Author: Oknet Xu <xu...@skyguard.com.cn>
Authored: Fri Apr 24 11:01:07 2015 +0800
Committer: Alan M. Carroll <am...@apache.org>
Committed: Wed Jun 17 21:01:37 2015 -0500
----------------------------------------------------------------------
doc/admin/getting-started.en.rst | 6 +-
doc/admin/http-proxy-caching.en.rst | 12 ++--
doc/admin/performance-tuning.en.rst | 2 +-
doc/admin/session-protocol.en.rst | 4 +-
.../api/TSHttpConnectWithPluginId.en.rst | 8 +--
.../api/TSHttpIsInternalRequest.en.rst | 4 ++
.../api/TSHttpTxnClientPacketMarkSet.en.rst | 2 +-
.../api/TSHttpTxnClientPacketTosSet.en.rst | 2 +-
.../api/TSHttpTxnServerPacketMarkSet.en.rst | 2 +-
.../api/TSHttpTxnServerPacketTosSet.en.rst | 2 +-
doc/reference/api/TSVConnTunnel.en.rst | 2 +-
doc/reference/configuration/remap.config.en.rst | 2 +
doc/reference/plugins/ts_lua.en.rst | 2 +-
lib/ck/doc/CK_RHS_HASH | 71 ++++++++++++++++++++
14 files changed, 98 insertions(+), 23 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/admin/getting-started.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/getting-started.en.rst b/doc/admin/getting-started.en.rst
index 045f044..f6327a5 100644
--- a/doc/admin/getting-started.en.rst
+++ b/doc/admin/getting-started.en.rst
@@ -1,7 +1,7 @@
-.. _getting-started:
+.. _admin-getting-started:
-Getting Started
-***************
+Admin - Getting Started
+***********************
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/admin/http-proxy-caching.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/http-proxy-caching.en.rst b/doc/admin/http-proxy-caching.en.rst
index 317b186..2ef0700 100644
--- a/doc/admin/http-proxy-caching.en.rst
+++ b/doc/admin/http-proxy-caching.en.rst
@@ -265,10 +265,8 @@ one of the following options:
*Traffic Server considers all HTTP objects in the cache to be fresh:*
Never revalidate HTTP objects in the cache with the origin server.
-*Traffic Server considers all HTTP objects without* ``Expires`` *or*
-``Cache-control`` *headers to be stale:*
- Revalidate all HTTP objects without ``Expires`` or
- ``Cache-Control`` headers.
+*Traffic Server considers all HTTP objects without* ``Expires`` *or* ``Cache-control`` *headers to be stale:*
+ Revalidate all HTTP objects without ``Expires`` or ``Cache-Control`` headers.
To configure how Traffic Server revalidates objects in the cache, you
can set specific revalidation rules in :file:`cache.config`.
@@ -600,16 +598,16 @@ of alternate versions of an object allowed in the cache.
Configuring How Traffic Server Caches Alternates
------------------------------------------------
-To configure how Traffic Server caches alternates::
+To configure how Traffic Server caches alternates:
-1. Edit the following variables in :file:`records.config`:
+#. Edit the following variables in :file:`records.config`:
- :ts:cv:`proxy.config.http.cache.enable_default_vary_headers`
- :ts:cv:`proxy.config.http.cache.vary_default_text`
- :ts:cv:`proxy.config.http.cache.vary_default_images`
- :ts:cv:`proxy.config.http.cache.vary_default_other`
-2. Run the command :option:`traffic_line -x` to apply the configuration changes.
+#. Run the command :option:`traffic_line -x` to apply the configuration changes.
.. note::
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/admin/performance-tuning.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/performance-tuning.en.rst b/doc/admin/performance-tuning.en.rst
index 616f299..c81dae7 100644
--- a/doc/admin/performance-tuning.en.rst
+++ b/doc/admin/performance-tuning.en.rst
@@ -15,7 +15,7 @@
specific language governing permissions and limitations
under the License.
-.. include:: common.defs
+.. include:: ../common.defs
.. _performance-tuning:
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/admin/session-protocol.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/session-protocol.en.rst b/doc/admin/session-protocol.en.rst
index 25d00b0..20a3bf1 100644
--- a/doc/admin/session-protocol.en.rst
+++ b/doc/admin/session-protocol.en.rst
@@ -20,8 +20,8 @@ Session Protocol
specific language governing permissions and limitations
under the License.
-Traffic Server supports some session level protocols in place of, or on top of.
- HTTP. These can be provided by a plugin (see :ref:`new-protocol-plugins`) or
+Traffic Server supports some session level protocols in place of, or on top of
+HTTP. These can be provided by a plugin (see :ref:`new-protocol-plugins`) or
be one that is supported directly by Traffic Server. The
`SPDY <http://www.chromium.org/spdy>`_ protocol is the only one currently
supported, but it is planned to support HTTP 2 when that is finalized.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/reference/api/TSHttpConnectWithPluginId.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpConnectWithPluginId.en.rst b/doc/reference/api/TSHttpConnectWithPluginId.en.rst
index c132a62..b5fa051 100644
--- a/doc/reference/api/TSHttpConnectWithPluginId.en.rst
+++ b/doc/reference/api/TSHttpConnectWithPluginId.en.rst
@@ -69,10 +69,10 @@ to internal mechanisms. Data is read and written to the connection
virtual connection.
.. note:: This function only opens the connection - to drive the
-transaction an actual HTTP request must be sent and the HTTP response
-handled. The transaction is handled as a standard HTTP transaction
-and all of the standard configuration options and plugins will
-operate on it.
+ transaction an actual HTTP request must be sent and the HTTP response
+ handled. The transaction is handled as a standard HTTP transaction
+ and all of the standard configuration options and plugins will
+ operate on it.
The combination of tag and id is intended to enable correlation in
log post processing. The tag identifies the connection as related
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/reference/api/TSHttpIsInternalRequest.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpIsInternalRequest.en.rst b/doc/reference/api/TSHttpIsInternalRequest.en.rst
index 26a9a6a..b3a41ba 100644
--- a/doc/reference/api/TSHttpIsInternalRequest.en.rst
+++ b/doc/reference/api/TSHttpIsInternalRequest.en.rst
@@ -37,11 +37,15 @@ was originated within Traffic Server.
.. admonition:: Deprecated
+ Deprecated
+
:func:`TSHttpIsInternalSession` tests whether a HTTP session
was originated within Traffic Server.
.. admonition:: Deprecated
+ Deprecated
+
Return Values
=============
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/reference/api/TSHttpTxnClientPacketMarkSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnClientPacketMarkSet.en.rst b/doc/reference/api/TSHttpTxnClientPacketMarkSet.en.rst
index 25c35ae..a1e3b1f 100644
--- a/doc/reference/api/TSHttpTxnClientPacketMarkSet.en.rst
+++ b/doc/reference/api/TSHttpTxnClientPacketMarkSet.en.rst
@@ -41,4 +41,4 @@ See Also
.. _Traffic Shaping:
https://cwiki.apache.org/confluence/display/TS/Traffic+Shaping
-:ts:cv:`proxy.config.net.sock_packet_mark_in` and TS-1090
+ :ts:cv:`proxy.config.net.sock_packet_mark_in` and TS-1090
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/reference/api/TSHttpTxnClientPacketTosSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnClientPacketTosSet.en.rst b/doc/reference/api/TSHttpTxnClientPacketTosSet.en.rst
index 25d7777..d59086a 100644
--- a/doc/reference/api/TSHttpTxnClientPacketTosSet.en.rst
+++ b/doc/reference/api/TSHttpTxnClientPacketTosSet.en.rst
@@ -45,4 +45,4 @@ See Also
.. _Traffic Shaping:
https://cwiki.apache.org/confluence/display/TS/Traffic+Shaping
-:ts:cv:`proxy.config.net.sock_packet_tos_in` and TS-1090
+ :ts:cv:`proxy.config.net.sock_packet_tos_in` and TS-1090
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/reference/api/TSHttpTxnServerPacketMarkSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnServerPacketMarkSet.en.rst b/doc/reference/api/TSHttpTxnServerPacketMarkSet.en.rst
index d4d253c..f71730f 100644
--- a/doc/reference/api/TSHttpTxnServerPacketMarkSet.en.rst
+++ b/doc/reference/api/TSHttpTxnServerPacketMarkSet.en.rst
@@ -43,4 +43,4 @@ See Also
.. _Traffic Shaping:
https://cwiki.apache.org/confluence/display/TS/Traffic+Shaping
-:ts:cv:`proxy.config.net.sock_packet_mark_out` and TS-1090
+ :ts:cv:`proxy.config.net.sock_packet_mark_out` and TS-1090
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/reference/api/TSHttpTxnServerPacketTosSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnServerPacketTosSet.en.rst b/doc/reference/api/TSHttpTxnServerPacketTosSet.en.rst
index 76137a0..2a6670d 100644
--- a/doc/reference/api/TSHttpTxnServerPacketTosSet.en.rst
+++ b/doc/reference/api/TSHttpTxnServerPacketTosSet.en.rst
@@ -47,4 +47,4 @@ See Also
.. _Traffic Shaping:
https://cwiki.apache.org/confluence/display/TS/Traffic+Shaping
-:ts:cv:`proxy.config.net.sock_packet_tos_out` and TS-1090
+ :ts:cv:`proxy.config.net.sock_packet_tos_out` and TS-1090
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/reference/api/TSVConnTunnel.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnTunnel.en.rst b/doc/reference/api/TSVConnTunnel.en.rst
index 0f3b8e7..a479df9 100644
--- a/doc/reference/api/TSVConnTunnel.en.rst
+++ b/doc/reference/api/TSVConnTunnel.en.rst
@@ -16,7 +16,7 @@
TSVConnTunnel
-===========
+=============
Synopsis
--------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/reference/configuration/remap.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/remap.config.en.rst b/doc/reference/configuration/remap.config.en.rst
index f870fe0..7355f16 100644
--- a/doc/reference/configuration/remap.config.en.rst
+++ b/doc/reference/configuration/remap.config.en.rst
@@ -21,6 +21,8 @@ remap.config
.. configfile:: remap.config
+.. include:: ../../common.defs
+
.. toctree::
:maxdepth: 2
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/doc/reference/plugins/ts_lua.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/ts_lua.en.rst b/doc/reference/plugins/ts_lua.en.rst
index b259f48..30bce3b 100644
--- a/doc/reference/plugins/ts_lua.en.rst
+++ b/doc/reference/plugins/ts_lua.en.rst
@@ -223,7 +223,7 @@ You can create global hook as well
ts.hook(TS_LUA_HOOK_READ_REQUEST_HDR, do_some_work)
-Or you can do it this way
+ Or you can do it this way
ts.hook(TS_LUA_HOOK_READ_REQUEST_HDR,
function()
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f7cbf468/lib/ck/doc/CK_RHS_HASH
----------------------------------------------------------------------
diff --git a/lib/ck/doc/CK_RHS_HASH b/lib/ck/doc/CK_RHS_HASH
new file mode 100644
index 0000000..43b8859
--- /dev/null
+++ b/lib/ck/doc/CK_RHS_HASH
@@ -0,0 +1,71 @@
+.\"
+.\" Copyright 2012-2013 Samy Al Bahra.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"
+.Dd March 28, 2012
+.Dt CK_RHS_HASH 3
+.Sh NAME
+.Nm CK_RHS_HASH
+.Nd invoke hash function with hash set seed
+.Sh LIBRARY
+Concurrency Kit (libck, \-lck)
+.Sh SYNOPSIS
+.In ck_rhs.h
+.Ft unsigned long
+.Fn CK_RHS_HASH "ck_rhs_t *hs" "ck_rhs_hash_cb_t *hf" "const void *key"
+.Sh DESCRIPTION
+The
+.Fn CK_RHS_HASH 3
+macro will invoke the hash function pointed to by the
+.Fa hf
+argument with the seed value associated with
+.Fa hs
+and the key pointer specified by the
+.Fa key
+argument.
+.Sh RETURN VALUES
+This function will return the value returned by the
+.Fa hf
+function.
+.Sh ERRORS
+It is expected
+.Fa hs
+was previously initialized via
+.Fn ck_rhs_init 3 .
+.Sh SEE ALSO
+.Xr ck_rhs_init 3 ,
+.Xr ck_rhs_destroy 3 ,
+.Xr ck_rhs_iterator_init 3 ,
+.Xr ck_rhs_next 3 ,
+.Xr ck_rhs_get 3 ,
+.Xr ck_rhs_put 3 ,
+.Xr ck_rhs_set 3 ,
+.Xr ck_rhs_remove 3 ,
+.Xr ck_rhs_grow 3 ,
+.Xr ck_rhs_count 3 ,
+.Xr ck_rhs_reset 3 ,
+.Xr ck_rhs_stat 3
+.Pp
+Additional information available at http://concurrencykit.org/