trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a..@apache.org
Subject [trafficserver] branch master updated: Refactor cache architecture docs
Date Fri, 05 May 2017 14:29:36 GMT
This is an automated email from the ASF dual-hosted git repository.

amc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git

The following commit(s) were added to refs/heads/master by this push:
       new  3e8da7a   Refactor cache architecture docs
3e8da7a is described below

commit 3e8da7ac6f47efa9bfd0f94357350bbe62611408
Author: Daniel Xu <dxu@dxuuu.xyz>
AuthorDate: Fri Apr 14 14:35:45 2017 -0500

    Refactor cache architecture docs
    
    Before, the cache architecture docs were ambiguously named
    "architecture". It also contained the `MemView` docs which aren't
    architecture related.
    
    This patch moves all the cache architecture docs into a directory
    called "cache-architecture" and the `MemView` docs into it's own
    "internal-libraries" folder.
---
 .../api-functions.en.rst                           |   0
 .../architecture.en.rst                            |   0
 .../consistency.en.rst                             |   0
 .../core-cache-functions.en.rst                    |   0
 .../data-structures.en.rst                         |   0
 .../images/ats-cache-volume-definition.png         | Bin
 .../images/ats-cache-volume-directory.png          | Bin
 .../images/ats-cache-volume-layout.png             | Bin
 .../images/ats-cache-write-cursor.png              | Bin
 .../images/cache-directory-structure.png           | Bin
 .../images/cache-doc-layout-3-2-0.png              | Bin
 .../images/cache-doc-layout-4-0-1.png              | Bin
 .../images/cache-multi-fragment.png                | Bin
 .../images/cache-span-layout.png                   | Bin
 .../images/cache-spans.png                         | Bin
 .../images/cache-stripe-layout.png                 | Bin
 .../images/dir-bucket-assign.png                   | Bin
 .../images/dir-segment-bucket.png                  | Bin
 .../index.en.rst                                   |   0
 .../ram-cache.en.rst                               |   0
 .../tiered-storage.en.rst                          |   0
 doc/developer-guide/index.en.rst                   |   3 ++-
 .../index.en.rst                                   |  25 +++++----------------
 .../memview.en.rst                                 |   0
 24 files changed, 8 insertions(+), 20 deletions(-)

diff --git a/doc/developer-guide/architecture/api-functions.en.rst b/doc/developer-guide/cache-architecture/api-functions.en.rst
similarity index 100%
rename from doc/developer-guide/architecture/api-functions.en.rst
rename to doc/developer-guide/cache-architecture/api-functions.en.rst
diff --git a/doc/developer-guide/architecture/architecture.en.rst b/doc/developer-guide/cache-architecture/architecture.en.rst
similarity index 100%
rename from doc/developer-guide/architecture/architecture.en.rst
rename to doc/developer-guide/cache-architecture/architecture.en.rst
diff --git a/doc/developer-guide/architecture/consistency.en.rst b/doc/developer-guide/cache-architecture/consistency.en.rst
similarity index 100%
rename from doc/developer-guide/architecture/consistency.en.rst
rename to doc/developer-guide/cache-architecture/consistency.en.rst
diff --git a/doc/developer-guide/architecture/core-cache-functions.en.rst b/doc/developer-guide/cache-architecture/core-cache-functions.en.rst
similarity index 100%
rename from doc/developer-guide/architecture/core-cache-functions.en.rst
rename to doc/developer-guide/cache-architecture/core-cache-functions.en.rst
diff --git a/doc/developer-guide/architecture/data-structures.en.rst b/doc/developer-guide/cache-architecture/data-structures.en.rst
similarity index 100%
rename from doc/developer-guide/architecture/data-structures.en.rst
rename to doc/developer-guide/cache-architecture/data-structures.en.rst
diff --git a/doc/developer-guide/architecture/images/ats-cache-volume-definition.png b/doc/developer-guide/cache-architecture/images/ats-cache-volume-definition.png
similarity index 100%
rename from doc/developer-guide/architecture/images/ats-cache-volume-definition.png
rename to doc/developer-guide/cache-architecture/images/ats-cache-volume-definition.png
diff --git a/doc/developer-guide/architecture/images/ats-cache-volume-directory.png b/doc/developer-guide/cache-architecture/images/ats-cache-volume-directory.png
similarity index 100%
rename from doc/developer-guide/architecture/images/ats-cache-volume-directory.png
rename to doc/developer-guide/cache-architecture/images/ats-cache-volume-directory.png
diff --git a/doc/developer-guide/architecture/images/ats-cache-volume-layout.png b/doc/developer-guide/cache-architecture/images/ats-cache-volume-layout.png
similarity index 100%
rename from doc/developer-guide/architecture/images/ats-cache-volume-layout.png
rename to doc/developer-guide/cache-architecture/images/ats-cache-volume-layout.png
diff --git a/doc/developer-guide/architecture/images/ats-cache-write-cursor.png b/doc/developer-guide/cache-architecture/images/ats-cache-write-cursor.png
similarity index 100%
rename from doc/developer-guide/architecture/images/ats-cache-write-cursor.png
rename to doc/developer-guide/cache-architecture/images/ats-cache-write-cursor.png
diff --git a/doc/developer-guide/architecture/images/cache-directory-structure.png b/doc/developer-guide/cache-architecture/images/cache-directory-structure.png
similarity index 100%
rename from doc/developer-guide/architecture/images/cache-directory-structure.png
rename to doc/developer-guide/cache-architecture/images/cache-directory-structure.png
diff --git a/doc/developer-guide/architecture/images/cache-doc-layout-3-2-0.png b/doc/developer-guide/cache-architecture/images/cache-doc-layout-3-2-0.png
similarity index 100%
rename from doc/developer-guide/architecture/images/cache-doc-layout-3-2-0.png
rename to doc/developer-guide/cache-architecture/images/cache-doc-layout-3-2-0.png
diff --git a/doc/developer-guide/architecture/images/cache-doc-layout-4-0-1.png b/doc/developer-guide/cache-architecture/images/cache-doc-layout-4-0-1.png
similarity index 100%
rename from doc/developer-guide/architecture/images/cache-doc-layout-4-0-1.png
rename to doc/developer-guide/cache-architecture/images/cache-doc-layout-4-0-1.png
diff --git a/doc/developer-guide/architecture/images/cache-multi-fragment.png b/doc/developer-guide/cache-architecture/images/cache-multi-fragment.png
similarity index 100%
rename from doc/developer-guide/architecture/images/cache-multi-fragment.png
rename to doc/developer-guide/cache-architecture/images/cache-multi-fragment.png
diff --git a/doc/developer-guide/architecture/images/cache-span-layout.png b/doc/developer-guide/cache-architecture/images/cache-span-layout.png
similarity index 100%
rename from doc/developer-guide/architecture/images/cache-span-layout.png
rename to doc/developer-guide/cache-architecture/images/cache-span-layout.png
diff --git a/doc/developer-guide/architecture/images/cache-spans.png b/doc/developer-guide/cache-architecture/images/cache-spans.png
similarity index 100%
rename from doc/developer-guide/architecture/images/cache-spans.png
rename to doc/developer-guide/cache-architecture/images/cache-spans.png
diff --git a/doc/developer-guide/architecture/images/cache-stripe-layout.png b/doc/developer-guide/cache-architecture/images/cache-stripe-layout.png
similarity index 100%
rename from doc/developer-guide/architecture/images/cache-stripe-layout.png
rename to doc/developer-guide/cache-architecture/images/cache-stripe-layout.png
diff --git a/doc/developer-guide/architecture/images/dir-bucket-assign.png b/doc/developer-guide/cache-architecture/images/dir-bucket-assign.png
similarity index 100%
rename from doc/developer-guide/architecture/images/dir-bucket-assign.png
rename to doc/developer-guide/cache-architecture/images/dir-bucket-assign.png
diff --git a/doc/developer-guide/architecture/images/dir-segment-bucket.png b/doc/developer-guide/cache-architecture/images/dir-segment-bucket.png
similarity index 100%
rename from doc/developer-guide/architecture/images/dir-segment-bucket.png
rename to doc/developer-guide/cache-architecture/images/dir-segment-bucket.png
diff --git a/doc/developer-guide/architecture/index.en.rst b/doc/developer-guide/cache-architecture/index.en.rst
similarity index 100%
copy from doc/developer-guide/architecture/index.en.rst
copy to doc/developer-guide/cache-architecture/index.en.rst
diff --git a/doc/developer-guide/architecture/ram-cache.en.rst b/doc/developer-guide/cache-architecture/ram-cache.en.rst
similarity index 100%
rename from doc/developer-guide/architecture/ram-cache.en.rst
rename to doc/developer-guide/cache-architecture/ram-cache.en.rst
diff --git a/doc/developer-guide/architecture/tiered-storage.en.rst b/doc/developer-guide/cache-architecture/tiered-storage.en.rst
similarity index 100%
rename from doc/developer-guide/architecture/tiered-storage.en.rst
rename to doc/developer-guide/cache-architecture/tiered-storage.en.rst
diff --git a/doc/developer-guide/index.en.rst b/doc/developer-guide/index.en.rst
index 5abe670..81ed665 100644
--- a/doc/developer-guide/index.en.rst
+++ b/doc/developer-guide/index.en.rst
@@ -43,7 +43,8 @@ duplicate bugs is encouraged, but not required.
    contributing/index.en
    testing-with-vagrant/index.en
    debugging/index.en
-   architecture/index.en
+   cache-architecture/index.en
+   internal-libraries/index.en
    plugins/index.en
    config-vars.en
    api/index.en
diff --git a/doc/developer-guide/architecture/index.en.rst b/doc/developer-guide/internal-libraries/index.en.rst
similarity index 57%
rename from doc/developer-guide/architecture/index.en.rst
rename to doc/developer-guide/internal-libraries/index.en.rst
index 04f38ef..de56316 100644
--- a/doc/developer-guide/architecture/index.en.rst
+++ b/doc/developer-guide/internal-libraries/index.en.rst
@@ -17,28 +17,15 @@
 
 .. include:: ../../common.defs
 
-.. _developer-architecture:
+.. _internal-libraries:
 
-Cache Architecture
-******************
+Internal libraries
+********************
 
-The original architectural documents for Traffic Server were lost in the
-transition to an open source project. The documents in this section are
-provisional and were written based on the existing code. The purpose is to have
-a high level description of aspects of Traffic Server to better inform ongoing
-work.
-
-In the final section on "hacking" we try to document our approaches to
-understanding and modifying the source.
+Here we document various internal libraries whose use is encouraged by |ATS|
+development team.
 
 .. toctree::
    :maxdepth: 2
 
-   architecture.en
-   core-cache-functions.en
-   data-structures.en
-   api-functions.en
-   consistency.en
-   ram-cache.en
-   tiered-storage.en
-   memview.en
+   memview.en.rst
diff --git a/doc/developer-guide/architecture/memview.en.rst b/doc/developer-guide/internal-libraries/memview.en.rst
similarity index 100%
rename from doc/developer-guide/architecture/memview.en.rst
rename to doc/developer-guide/internal-libraries/memview.en.rst

-- 
To stop receiving notification emails like this one, please contact
['"commits@trafficserver.apache.org" <commits@trafficserver.apache.org>'].

Mime
View raw message