[llvm-commits] [zorg] r152827 - in /zorg/trunk/lnt/docs: contents.rst intro.rst quickstart.rst

[Daniel Dunbar]

Author: ddunbar
Date: Thu Mar 15 14:45:34 2012
New Revision: 152827

URL: http://llvm.org/viewvc/llvm-project?rev=152827&view=rev
Log:
[LNT] docs: Start work on a quickstart guide.

Added:
    zorg/trunk/lnt/docs/quickstart.rst
Modified:
    zorg/trunk/lnt/docs/contents.rst
    zorg/trunk/lnt/docs/intro.rst

Modified: zorg/trunk/lnt/docs/contents.rst
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/lnt/docs/contents.rst?rev=152827&r1=152826&r2=152827&view=diff
==============================================================================
--- zorg/trunk/lnt/docs/contents.rst (original)
+++ zorg/trunk/lnt/docs/contents.rst Thu Mar 15 14:45:34 2012
@@ -8,6 +8,8 @@
 
    intro
 
+   quickstart
+
    tools
 
    tests

Modified: zorg/trunk/lnt/docs/intro.rst
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/lnt/docs/intro.rst?rev=152827&r1=152826&r2=152827&view=diff
==============================================================================
--- zorg/trunk/lnt/docs/intro.rst (original)
+++ zorg/trunk/lnt/docs/intro.rst Thu Mar 15 14:45:34 2012
@@ -21,13 +21,8 @@
 Installation
 ------------
 
-These are the (current) rough steps to get a working LNT client:
-
- 1. Install LNT:
-
-      python setup.py install
-
-    It is recommended that you install LNT into a virtualenv.
+If you are only interested in using LNT to run tests locally, see the
+:ref:`quickstart`.
 
 If you want to run an LNT server, you will need to perform the following
 additional steps:
@@ -49,7 +44,7 @@
 
     a. Update the databases list.
 
-    b. Update the zorgURL.
+    b. Update the public URL the server is visible at.
 
     c. Update the nt_emailer configuration.
 

Added: zorg/trunk/lnt/docs/quickstart.rst
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/lnt/docs/quickstart.rst?rev=152827&view=auto
==============================================================================
--- zorg/trunk/lnt/docs/quickstart.rst (added)
+++ zorg/trunk/lnt/docs/quickstart.rst Thu Mar 15 14:45:34 2012
@@ -0,0 +1,76 @@
+.. _quickstart:
+
+Quickstart Guide
+================
+
+This quickstart guide is designed for LLVM developers who are primarily
+interested in using LNT to test compilers using the LLVM test-suite.
+
+Installation
+------------
+
+The first thing to do is to checkout install the LNT software itself. The
+following steps should suffice on any modern Unix variant:
+
+#. Install ``virtualenv``, if necessary::
+
+           sudo easy_install virtualenv
+
+   ``virtualenv`` is a standard Python tool for allowing the installation of
+   Python applications into their own sandboxes, or virtual environments.
+
+#. Create a new virtual environment for the LNT application::
+
+            virtualenv ~/mysandbox
+
+   This will create a new virtual environment at ``~/mysandbox``.
+
+#. Checkout the LNT sources::
+
+            svn co http://llvm.org/svn/llvm-project/zorg/trunk/lnt ~/lnt
+
+#. Install LNT into the virtual environment::
+
+           ~/mysandbox/bin/python ~/lnt/setup.py develop
+
+   We recommend using ``develop`` instead of install for local use, so that any
+   changes to the LNT sources are immediately propagated to your
+   installation. If you are running a production install or care a lot about
+   stability, you can use ``install`` which will copy in the sources and you
+   will need to explicitly re-install when you wish to update the LNT
+   application.
+
+That's it!
+
+Running Tests
+-------------
+
+To execute the LLVM test-suite using LNT you use the ``lnt runtest``
+command. The information below should be enough to get you started, but see the
+:ref:`tests` section for more complete documentation.
+
+#. Checkout the LLVM test-suite, if you haven't already::
+
+             svn co http://llvm.org/svn/llvm-project/test-suite/trunk ~/llvm-test-suite
+
+   You should always keep the test-suite directory itself clean (that is, never
+   do a configure inside your test suite). Make sure not to check it out into
+   the LLVM projects directory, as LLVM's configure/make build will then want to
+   automatically configure it for you.
+
+#. Execute the ``lnt runtest nt`` test producer, point it at the test suite and
+   the compiler you want to test::
+
+           lnt runtest nt \
+               --sandbox SANDBOX \
+               --cc ~/llvm.obj/Release/bin/clang \
+               --cxx ~/llvm.obj/Release/bin/clang++ \
+               --test-suite ~/llvm-test-suite \
+               MACHINENAME
+
+   The ``SANDBOX`` value is a path to where the test suite build products and
+   results will be stored (inside a timestamped directory, by default).
+
+   The ``MACHINENAME`` value is used to identify the machine that produced the
+   results. This is only important if you plan on submitting the results to a
+   server (but is always required, I just use 'FOO' for dummy runs).