You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2013/08/27 07:08:08 UTC

git commit: doc: move cache glossary into the main glossary

Updated Branches:
  refs/heads/master fc139c218 -> 463356348


doc: move cache glossary into the main glossary


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/46335634
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/46335634
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/46335634

Branch: refs/heads/master
Commit: 463356348c87018bf3d9e22fc00fce2c92f11325
Parents: fc139c2
Author: James Peach <jp...@apache.org>
Authored: Mon Aug 26 22:06:53 2013 -0700
Committer: James Peach <jp...@apache.org>
Committed: Mon Aug 26 22:07:42 2013 -0700

----------------------------------------------------------------------
 doc/arch/cache/cache-glossary.en.rst | 39 -------------------------------
 doc/arch/cache/cache.en.rst          |  2 --
 doc/glossary.en.rst                  | 17 ++++++++++++++
 3 files changed, 17 insertions(+), 41 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/46335634/doc/arch/cache/cache-glossary.en.rst
----------------------------------------------------------------------
diff --git a/doc/arch/cache/cache-glossary.en.rst b/doc/arch/cache/cache-glossary.en.rst
deleted file mode 100755
index 7c433aa..0000000
--- a/doc/arch/cache/cache-glossary.en.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-.. 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.
-
-Glossary
-~~~~~~~~
-
-.. include:: common.defs
-
-.. glossary::
-    :sorted:
-
-    cache volume
-        Persistent storage for the cache, defined and manipulable by the user. Cache volumes are defined in :file:`volume.config`. A cache volume is spread across :term:`storage unit`\ s to increase performance through parallel I/O. Storage units can be split across cache volumes. Each such part of a storage unit in a cache volume is a :term:`volume`.
-
-        Implemented by the class :cpp:class:`CacheVol`.
-
-    volume
-        A homogenous persistent store for the cache. A volume always resides entirely on a single physical device and is treated as an undifferentiated span of bytes.
-
-        Implemented by the class :cpp:class:`Vol`.
-
-        See also :term:`storage unit`, :term:`cache volume`
-
-    storage unit
-        The physical storage described by a single line in :file:`storage.config`.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/46335634/doc/arch/cache/cache.en.rst
----------------------------------------------------------------------
diff --git a/doc/arch/cache/cache.en.rst b/doc/arch/cache/cache.en.rst
index c917209..43b5d84 100644
--- a/doc/arch/cache/cache.en.rst
+++ b/doc/arch/cache/cache.en.rst
@@ -27,8 +27,6 @@ Contents:
    cache-data-structures.en
    cache-api.en
    cache-appendix.en
-   cache-glossary.en
    tier-storage.en
 
-..   glossary
 ..   appendix

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/46335634/doc/glossary.en.rst
----------------------------------------------------------------------
diff --git a/doc/glossary.en.rst b/doc/glossary.en.rst
index d33bf19..76accf9 100644
--- a/doc/glossary.en.rst
+++ b/doc/glossary.en.rst
@@ -20,6 +20,7 @@ Glossary
 =============
 
 .. glossary::
+   :sorted:
 
    continuation
       A callable object that contains state. These are are mechanism used by Traffic Server to implement callbacks and
@@ -34,3 +35,19 @@ Glossary
    transaction
       A client request and response, either from the origin server or from the cache.
 
+   cache volume
+      Persistent storage for the cache, defined and manipulable by the user.
+      Cache volumes are defined in :file:`volume.config`. A cache volume is
+      spread across :term:`storage unit`\ s to increase performance through
+      parallel I/O. Storage units can be split across cache volumes. Each
+      such part of a storage unit in a cache volume is a :term:`volume`.
+
+   volume
+      A homogenous persistent store for the cache. A volume always resides
+      entirely on a single physical device and is treated as an
+      undifferentiated span of bytes.
+
+      See also :term:`storage unit`, :term:`cache volume`
+
+   storage unit
+      The physical storage described by a single line in :file:`storage.config`.