[07/11] incubator-trafficcontrol git commit: more explicit instructions + alternate instructions using docker-compose

[fr...@apache.org]

more explicit instructions + alternate instructions using docker-compose

(cherry picked from commit 3b93cb610dde5519268bec84afeab46fb0ac25c6)


Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/1120faf6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/1120faf6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/1120faf6

Branch: refs/heads/2.0.x
Commit: 1120faf677bc287c8e30bc42b9c73f437932d01e
Parents: 0a6cf8b
Author: Dan Kirkwood <da...@gmail.com>
Authored: Tue Jun 13 15:58:09 2017 -0600
Committer: Eric Friedrich <fr...@apache.org>
Committed: Wed Jun 14 15:50:49 2017 -0400

----------------------------------------------------------------------
 docs/source/development/building.rst | 56 ++++++++++++++++++++++---------
 1 file changed, 41 insertions(+), 15 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/1120faf6/docs/source/development/building.rst
----------------------------------------------------------------------
diff --git a/docs/source/development/building.rst b/docs/source/development/building.rst
index addb27e..27c4a2d 100644
--- a/docs/source/development/building.rst
+++ b/docs/source/development/building.rst
@@ -1,8 +1,11 @@
-Building Traffic Control Components
-===================================
+.. _dev-building:
+
+Building Traffic Control
+========================
 
-Build using docker-compose
---------------------------
+
+Build using pkg
+---------------
 
 This is the easiest way to build all the components of Traffic Control;
 all requirements are automatically loaded into the image used to build
@@ -19,16 +22,9 @@ If ``docker-compose`` is not available, the ``pkg`` script will
 automatically download and run it in a container. This is noticeably
 slower than running it natively.
 
-Steps
+Usage
 ~~~~~
 
-From the top level of the incubator-trafficcontrol directory. The source
-in the current directory is used for the process. One or more components
-(with \_build suffix added) can be added on the command line.
-
-This is all run automatically by the ``pkg`` script at the root of the
-repository.
-
 ::
 
     $ ./pkg -?
@@ -46,8 +42,38 @@ repository.
                 - traffic_ops_build
                 - traffic_stats_build
 
-If no component names are provided on the command line, all components
-will be built.
 
-All rpms are copied to ``dist`` at the top level of the
+If any project names are provided on the command line, only those will be built.
+Otherwise, all projects are built.
+
+All artifacts (rpms, logs, source tar ball) are copied to ``dist`` at the top level of the
 ``incubator-trafficcontrol`` directory.
+
+Example
+~~~~~~~
+
+::
+
+    $ ./pkg -v source traffic_ops_build
+    Building source.
+    Building traffic_ops_build.
+
+Build using docker-compose
+--------------------------
+
+If the ``pkg`` script fails, ``docker-compose`` can still be used directly.
+
+Usage
+~~~~~
+
+::
+
+    $ docker-compose -f ./infrastructure/docker/build/docker-compose.yml down -v
+    $ docker-compose -f ./infrastructure/docker/build/docker-compose.yml up --build source traffic_ops_build
+    $ ls -1 dist/
+    build-traffic_ops.log
+    traffic_ops-2.1.0-6396.07033d6d.el7.src.rpm
+    traffic_ops-2.1.0-6396.07033d6d.el7.x86_64.rpm
+    traffic_ops_ort-2.1.0-6396.07033d6d.el7.src.rpm
+    traffic_ops_ort-2.1.0-6396.07033d6d.el7.x86_64.rpm
+    trafficcontrol-incubating-2.1.0.tar.gz