trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a..@apache.org
Subject [1/2] Documentation: Added 'arch' (Architecture) section. Added cache documents. Fixed many warnings. Added Tiered Storage proposal.
Date Sat, 10 Aug 2013 00:38:47 GMT
Updated Branches:
  refs/heads/master 8ecd7e66c -> 7c21e68ef


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7c21e68e/doc/ext/traffic-server.py
----------------------------------------------------------------------
diff --git a/doc/ext/traffic-server.py b/doc/ext/traffic-server.py
index 2a978f2..36959fb 100644
--- a/doc/ext/traffic-server.py
+++ b/doc/ext/traffic-server.py
@@ -149,12 +149,42 @@ class TrafficServerDomain(Domain):
         for var, doc in self.data['cv'].iteritems():
             yield var, var, 'cv', doc, var, 1
 
+# These types are ignored as missing references for the C++ domain.
+EXTERNAL_TYPES = set((
+    'int',
+    'uint8_t', 'uint16_t', 'uint24_t', 'uint32_t', 'uint64_t',
+    'off_t',
+    'Event', 'INK_MD5', 'DLL<EvacuationBlock>',
+    ))
+
+# Clean up specific references that we know will never be defined but are implicitly used
by
+# other domain directives. Hand convert them to literals.
+def xref_cleanup(app, env, node, contnode):
+    rdomain = node['refdomain']
+    rtype = node['reftype']
+    rtarget = node['reftarget']
+    if 'cpp' == rdomain:
+        if 'type' == rtype:
+            if rtarget in EXTERNAL_TYPES:
+                node = nodes.literal()
+                node += contnode
+                return node
+            # allow pointer or reference decorations
+            if ('*' == rtarget[-1] or '&' == rtarget[-1]) and rtarget[:-1] in EXTERNAL_TYPES:
+                return contnode
+    return;
+
 def setup(app):
     app.add_crossref_type('configfile', 'file',
                         objname='Configuration file',
                         indextemplate='pair: %s; Configuration files')
+
+    rst.roles.register_generic_role('arg', nodes.emphasis);
+
     app.add_domain(TrafficServerDomain)
 
     # Types that we want the C domain to consider built in
-    for word in ('size_t'):
+    for word in EXTERNAL_TYPES:
         sphinx.domains.c.CObject.stopwords.add(word)
+
+    app.connect('missing-reference', xref_cleanup)

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7c21e68e/doc/index.rst
----------------------------------------------------------------------
diff --git a/doc/index.rst b/doc/index.rst
index 951bd86..a665ea1 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -43,6 +43,7 @@ bandwidth.
   reference/commands/index.en
   reference/plugins/index.en
   reference/api/index.en
+  arch/index.en
 
 Indices and tables
 ==================

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7c21e68e/doc/reference/api/TSHttpHookAdd.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpHookAdd.en.rst b/doc/reference/api/TSHttpHookAdd.en.rst
index 657b336..0200fc7 100644
--- a/doc/reference/api/TSHttpHookAdd.en.rst
+++ b/doc/reference/api/TSHttpHookAdd.en.rst
@@ -28,6 +28,13 @@ Synopsis
 .. function:: void TSHttpSsnHookAdd(TSHttpSsn ssnp, TSHttpHookID id, TSCont contp)
 .. function:: void TSHttpTxnHookAdd(TSHttpTxn txnp, TSHttpHookID id, TSCont contp)
 
+.. rubric:: Opaque types
+
+.. type:: TSHttpTxn
+.. type:: TSHttpSsn
+.. type:: TSHttpHookID
+.. type:: TSCont
+
 Description
 ===========
 
@@ -46,20 +53,20 @@ transaction. :func:`TSHttpHookAdd` is typically called from
 A session consists of a single client connection to Traffic Server.
 A session can consist of several transactions in succession. The
 session starts when the client connection opens, and ends when the
-connection closes. :func:`TSHttpSsnHookAdd` adds :data:`contp` to
-the end of the list of HTTP transaction hooks specified by :data:`id`.
-This means that :data:`contp` is called back for every transaction
+connection closes. :func:`TSHttpSsnHookAdd` adds :arg:`contp` to
+the end of the list of HTTP transaction hooks specified by :arg:`id`.
+This means that :arg:`contp` is called back for every transaction
 within the session, at the point specified by the hook ID. Since
-:data:`contp` is added to a session, it is not possible to call
+:arg:`contp` is added to a session, it is not possible to call
 :func:`TSHttpSsnHookAdd` from the plugin initialization routine;
 the plugin needs a handle to an HTTP session.
 
 A transaction consists of a single HTTP request from a client and
 the response that Traffic Server sends to that client. A transaction
 begins when Traffic Server receives a request, and ends when Traffic
-Server sends the response. :func:`TSHttpTxnHookAdd` adds :data:`contp`
+Server sends the response. :func:`TSHttpTxnHookAdd` adds :arg:`contp`
 to the end of the list of HTTP transaction hooks specified by
-:data:`id`. Since :data:`contp` is added to a transaction, it is
+:arg:`id`. Since :arg:`contp` is added to a transaction, it is
 not possible to call :func:`TSHttpTxnHookAdd` from the plugin
 initialization routine but only when the plugin has a handle to an
 HTTP transaction.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7c21e68e/doc/reference/configuration/ip_allow.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/ip_allow.config.en.rst b/doc/reference/configuration/ip_allow.config.en.rst
index 49812a1..f8cc67b 100644
--- a/doc/reference/configuration/ip_allow.config.en.rst
+++ b/doc/reference/configuration/ip_allow.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.
 
 ===============
 ip_allow.config

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7c21e68e/doc/reference/configuration/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
index 1ca3cfb..6ff82fa 100644
--- a/doc/reference/configuration/records.config.en.rst
+++ b/doc/reference/configuration/records.config.en.rst
@@ -1064,6 +1064,10 @@ Customizable User Response Pages
    -  ``1`` = always suppress generated response pages
    -  ``2`` = suppress response pages only for intercepted traffic
 
+.. ts:cv:: CONFIG proxy.config.http_ui_enabled INT 0
+
+   Enable the user interface page.
+
 DNS
 ===
 
@@ -1090,9 +1094,11 @@ hostname to ``host_x.y.com``.
    Traffic Server to add the hostname extension .org, then specify ``org`` as the value for
this variable (Traffic Server automatically
    adds the dot (.)).
 
-   **Note:** If the variable
-   `proxy.config.http.enable_url_expandomatic`_ is set to ``1`` (the default value), then
you do not have to add *``www.``* and
-   *``.com``* to this list because Traffic Server automatically tries www. and .com after
trying the values you've specified.
+.. note::
+
+   If the variable :ts:cv:`proxy.config.http.enable_url_expandomatic` is set to ``1`` (the
default value), then you do not have to
+   add *``www.``* and *``.com``* to this list because Traffic Server automatically tries
www. and .com after trying the values
+   you've specified.
 
 .. ts:cv:: CONFIG proxy.config.dns.resolv_conf STRING /etc/resolv.conf
 
@@ -1554,6 +1560,10 @@ SSL Termination
    :file:`ssl_multicert.config` will be loaded relative to this
    path.
 
+.. ts:cv:: CONFIG proxy.config.ssl.server.private_key.filename STRING NULL
+
+   TBD
+
 .. ts:cv:: CONFIG proxy.config.ssl.server.cert_chain.filename STRING NULL
 
    The name of a file containing a global certificate chain that
@@ -1572,6 +1582,10 @@ SSL Termination
    The filename of the certificate authority that client certificates
    will be verified against.
 
+.. ts:cv:: CONFIG proxy.config.ssl.auth.enabled INT 0
+
+   TBD
+
 Client-Related Configuration
 ----------------------------
 


Mime
View raw message