X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FProjects.rst;h=63132887a5990c40844f71cfbe7baeceef8d8c6e;hb=8f00ae6a3f8d392ce0f42a81223e479f97876d7f;hp=036aaf274d761120580fc726964a1c97f0cd36a2;hpb=67d31c6229ab09be61a3718ae940241eca36213b;p=oota-llvm.git diff --git a/docs/Projects.rst b/docs/Projects.rst index 036aaf274d7..63132887a59 100644 --- a/docs/Projects.rst +++ b/docs/Projects.rst @@ -85,10 +85,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 +102,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. @@ -273,16 +273,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``. @@ -290,8 +290,7 @@ Note that ``LIBS`` must occur in the Makefile after the inclusion of Miscellaneous Variables ----------------------- -``CFLAGS`` -``CPPFLAGS`` +``CFLAGS`` & ``CPPFLAGS`` This variable can be used to add options to the C and C++ compiler, respectively. It is typically used to add options that tell the compiler @@ -310,14 +309,14 @@ you do a ``Debug``, ``Release``, or ``Profile`` build. Libraries All libraries (static and dynamic) will be stored in - ``PROJ_OBJ_ROOT//lib``, where *``type``* is ``Debug``, ``Release``, or + ``PROJ_OBJ_ROOT//lib``, where *type* is ``Debug``, ``Release``, or ``Profile`` for a debug, optimized, or profiled build, respectively. Executables - All executables will be stored in ``PROJ_OBJ_ROOT//bin``, where - *``type``* is ``Debug``, ``Release``, or ``Profile`` for a debug, optimized, - or profiled build, respectively. + All executables will be stored in ``PROJ_OBJ_ROOT//bin``, where *type* + is ``Debug``, ``Release``, or ``Profile`` for a debug, optimized, or + profiled build, respectively. Further Help ============