You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2014/01/27 21:41:36 UTC
[06/28] git commit: TS-2521: add stub for hacking documentation
TS-2521: add stub for hacking documentation
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/532003b2
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/532003b2
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/532003b2
Branch: refs/heads/5.0.x
Commit: 532003b27063138e2a584bb4981b7b9179ca86c6
Parents: f8cb336
Author: Igor Galić <i....@brainsware.org>
Authored: Wed Jan 22 14:36:08 2014 +0100
Committer: Igor Galić <i....@brainsware.org>
Committed: Wed Jan 22 14:36:08 2014 +0100
----------------------------------------------------------------------
doc/arch/hacking/index.en.rst | 26 ++++++++++++++++++++++++++
doc/arch/index.en.rst | 9 ++++++---
2 files changed, 32 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/532003b2/doc/arch/hacking/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/arch/hacking/index.en.rst b/doc/arch/hacking/index.en.rst
new file mode 100644
index 0000000..b7edc7d
--- /dev/null
+++ b/doc/arch/hacking/index.en.rst
@@ -0,0 +1,26 @@
+Hacking
+*******
+
+.. 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.
+
+Introduction
+------------
+
+This is a documentation stub on how to hack Apache Traffic Server. Here we try to document things such as how to write
+and run unit or regression tests or how to inspect the state of the core with a debugger.
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/532003b2/doc/arch/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/arch/index.en.rst b/doc/arch/index.en.rst
index 51f5b83..6cc9fac 100644
--- a/doc/arch/index.en.rst
+++ b/doc/arch/index.en.rst
@@ -1,5 +1,5 @@
-Architecture
-******************
+Architecture and Hacking
+************************
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
@@ -21,10 +21,12 @@ Architecture
Introduction
--------------
-The original architectural documents for Traffic Server were lost in the transation to an open source project. The
+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.
+
Contents:
.. toctree::
@@ -32,3 +34,4 @@ Contents:
cache/cache.en
proposals/hostdb.en
+ hacking/index.en