Updated Branches:
  refs/heads/master 941784b2a -> 791466d3a

TS-1901 Update build docs


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

Branch: refs/heads/master
Commit: 791466d3a000c63bef2cc3d115780dcb0eb5db00
Parents: 941784b
Author: Leif Hedstrom <[email protected]>
Authored: Fri Jul 19 10:10:03 2013 -0600
Committer: Leif Hedstrom <[email protected]>
Committed: Fri Jul 19 10:10:03 2013 -0600

----------------------------------------------------------------------
 INSTALL |  6 +++++-
 README  | 54 ++++++++++++++++++++++++++++++++++++------------------
 2 files changed, 41 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/791466d3/INSTALL
----------------------------------------------------------------------
diff --git a/INSTALL b/INSTALL
index 18cd184..50901bb 100644
--- a/INSTALL
+++ b/INSTALL
@@ -15,7 +15,7 @@ online, at
 BUILD AND INSTALLATION
 ----------------------
 
-Configure & Build from source:
+Configure & Build from Git source tree:
     $ autoreconf -if  # generate the configure script and Makefile.in files
 
 On Linux, OSX:
@@ -51,6 +51,10 @@ configuration time:
 
     $ ./configure CXXFLAGS=-Os CFLAGS=-Os
 
+To compile with an alternate set of compilers, e.g. LLVM/Clang
+
+    $ ./configure CC=clang CXX=clang++
+
 
 INITIAL CONFIGURATION
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/791466d3/README
----------------------------------------------------------------------
diff --git a/README b/README
index f4a696e..ec0297b 100644
--- a/README
+++ b/README
@@ -7,29 +7,47 @@ plugins to build large scale web applications.
 1. DIRECTORY STRUCTURE
 
   traffic/ ............... top src dir
-  |-- cop ................ traffic_cop application
-  |-- doc/ ............... generated documentation
+  |-- ci/ ................ quality assurance and other CI tools and configs
+  |-- contrib ............ various contributed auxiliary pieces
+  |-- cop/ ............... traffic_cop application
+  |-- doc/ ...............
+      |-- admin/ ......... Admin guide documentations
+      |-- dot/ ........... Graphviz source files for docs pictures
+      |-- man/ ........... Unix style man-pages
+      |-- plugins ........ Documentation for our core plugins
+      |-- sdk/ ........... Plugin developer guide
   |-- example/ ........... example plugins
   |-- install/ ........... installation programs and scripts
-  |-- iocore/ ............ IO core
+  |-- iocore/ ............
+      |-- aio/ ........... Asynchronous I/O core
+      |-- cache/ ......... Disk and RAM cache
+      |-- cluster/ ....... Cache and configuration clustering
+      |-- dns/ ........... DNS (asynchronous)
+      |-- hostdb/ ........ Internal DNS cache
+      |-- net/ ........... Network
   |-- lib/ ...............
+      |-- cpp11api ....... C++ '11 wrapper for plugin developers
+      |-- records/ ....... library for config files
+      |-- perl/ .......... Perl libraries for e.g. mgmt access and 
configurations
       |-- ts/ ............ Base / core library
       |-- tsconfig/....... New config parser and library (experimental)
-      |-- records/ ....... library for config files
+      |-- wccp/ .......... WCCP implementation
   |-- m4/ ................ custom macros for configure.ac
   |-- mgmt/ .............. Management server and tools (including 
traffic_manager)
       |-- cli ............ Command line utilities and API
+  |-- plugins/ ........... Core plugins (stable and experiemental)
   |-- proxy/ ............. HTTP proxy logic
-  |-- test/ .............. functional tests
-  |-- .indent.pro ........ indent profile for coding style
-  |-- emacs-style ........ emacs style definition
+      |-- api/ ........... Plugin API includes
+      |-- config/ ........ Configurations
+      |-- congest/ ....... Congestion control
+      |-- hdrs/ .......... Headers parsing and management
+      |-- http/ .......... The actual HTTP protocol implementation
+      |-0 logging/ ....... Flexible logging
   |-- README ............. intro, links, build info
   |-- README-EC2 ......... info on EC2 support
   |-- REVIEWERS .......... (incomplete) list of areas with committer interest
   |-- LICENSE ............ full license text
-  |-- NOTICE ............. copyright notices
-  |-- configure.ac ....... autoconf configuration
-  `-- Makefile.am ........ top level automake configuration
+  `-- NOTICE ............. copyright notices
 
 2. REQUIREMENTS
 
@@ -51,9 +69,9 @@ plugins to build large scale web applications.
     expat-devel
     pcre
     pcre-devel
-    libcap-devel (optional)
-    flex (optional)
-    hwloc-devel (optional)
+    libcap-devel (optional, highly recommended)
+    flex (optional, needed for e.g. WCCP)
+    hwloc-devel (optional, highly recommended)
     lua-devel (optional)
 
   Fedora 8 EC2 (Kernel: 2.6.21.7-2.ec2.v1.2.fc8xen):
@@ -87,9 +105,9 @@ plugins to build large scale web applications.
     expat
     libexpat-dev
     libpcre3-dev
-    libcap-dev (optional)
-    flex (optional)
-    libhwloc-dev (optional)
+    libcap-dev (optional, highly recommended)
+    flex (optional, required for e.g. WCCP)
+    libhwloc-dev (optional, highly recommended)
     liblua5.1-dev or libluajit-5.1-dev (optional)
 
   Ubuntu EC2 9.10:
@@ -110,7 +128,7 @@ plugins to build large scale web applications.
     libexpat-dev
     libpcre3-dev
     flex (optional)
-    libhwloc-dev (optional)
+    libhwloc-dev (optional, highly recommended)
     liblua-dev (optional)
 
   FreeBSD 7.2,8.0,9.0,9.1
@@ -126,7 +144,7 @@ plugins to build large scale web applications.
     security/openssl
     devel/pcre
     textproc/flex (optional, install newer version from ports, fix PATH)
-    devel/hwloc (optional)
+    devel/hwloc (optional, highly recommended)
     lang/lua (optional, on x64 don't use LuaJIT!)
 
   OmniOS:

Reply via email to