X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FProjects.rst;h=3246e3ff169b4496571ace6d9457fe8e1e64d824;hb=566fb9fe3ed767be7218fb1608ec6a284067d3b0;hp=5935aeb9377a5e3a476bcc33d41852631130016e;hpb=540fe7da0f418f72baa3c97b4dbf25785ffc7da9;p=oota-llvm.git diff --git a/docs/Projects.rst b/docs/Projects.rst index 5935aeb9377..3246e3ff169 100644 --- a/docs/Projects.rst +++ b/docs/Projects.rst @@ -1,5 +1,3 @@ -.. _projects: - ======================== Creating an LLVM Project ======================== @@ -85,10 +83,10 @@ Follow these simple steps to start your project: with these commands. (You must be using ``Autoconf`` version 2.59 or later and your ``aclocal`` version should be 1.9 or later.) -.. code-block:: bash + .. code-block:: bash - % cd autoconf - % ./AutoRegen.sh + % cd autoconf + % ./AutoRegen.sh 6. Run ``configure`` in the directory in which you want to place object code. Use the following options to tell your project where it can find LLVM: @@ -102,7 +100,7 @@ Follow these simple steps to start your project: ``--prefix=`` Tell your project where it should get installed. -That's it! Now all you have to do is type ``gmake`` (or ``make`` if your on a +That's it! Now all you have to do is type ``gmake`` (or ``make`` if you're on a GNU/Linux system) in the root of your object directory, and your project should build. @@ -153,12 +151,10 @@ Underneath your top level directory, you should have the following directories: Currently, the LLVM build system provides basic support for tests. The LLVM system provides the following: -* LLVM provides a ``tcl`` procedure that is used by ``Dejagnu`` to run tests. - It can be found in ``llvm/lib/llvm-dg.exp``. This test procedure uses ``RUN`` +* LLVM contains regression tests in ``llvm/test``. These tests are run by the + :doc:`Lit ` testing tool. This test procedure uses ``RUN`` lines in the actual test case to determine how to run the test. See the - `TestingGuide `_ for more details. You can easily write - Makefile support similar to the Makefiles in ``llvm/test`` to use ``Dejagnu`` - to run your project's tests. + :doc:`TestingGuide` for more details. * LLVM contains an optional package called ``llvm-test``, which provides benchmarks and programs that are known to compile with the Clang front @@ -273,16 +269,16 @@ Variables for Building Programs ``LIBS`` - To link dynamic libraries, add -l<library base name> to the - ``LIBS`` variable. The LLVM build system will look in the same places for - dynamic libraries as it does for static libraries. + To link dynamic libraries, add ``-l`` to the ``LIBS`` + variable. The LLVM build system will look in the same places for dynamic + libraries as it does for static libraries. For example, to link ``libsample.so``, you would have the following line in your ``Makefile``: -.. code-block: Makefile + .. code-block:: makefile - LIBS += -lsample + LIBS += -lsample Note that ``LIBS`` must occur in the Makefile after the inclusion of ``Makefile.common``.