-.. _projects:
-
========================
Creating an LLVM Project
========================
* Set ``make`` variables. There are several variables that a ``Makefile`` needs
to set to use the LLVM build system:
- * ``PROJECT_NAME`` — The name by which your project is known.
- * ``LLVM_SRC_ROOT`` — The root of the LLVM source tree.
- * ``LLVM_OBJ_ROOT`` — The root of the LLVM object tree.
- * ``PROJ_SRC_ROOT`` — The root of the project's source tree.
- * ``PROJ_OBJ_ROOT`` — The root of the project's object tree.
- * ``PROJ_INSTALL_ROOT`` — The root installation directory.
- * ``LEVEL`` — The relative path from the current directory to the
+ * ``PROJECT_NAME`` - The name by which your project is known.
+ * ``LLVM_SRC_ROOT`` - The root of the LLVM source tree.
+ * ``LLVM_OBJ_ROOT`` - The root of the LLVM object tree.
+ * ``PROJ_SRC_ROOT`` - The root of the project's source tree.
+ * ``PROJ_OBJ_ROOT`` - The root of the project's object tree.
+ * ``PROJ_INSTALL_ROOT`` - The root installation directory.
+ * ``LEVEL`` - The relative path from the current directory to the
project's root ``($PROJ_OBJ_ROOT)``.
* Include ``Makefile.config`` from ``$(LLVM_OBJ_ROOT)``.
Follow these simple steps to start your project:
-#. Copy the ``llvm/projects/sample`` directory to any place of your choosing.
+1. Copy the ``llvm/projects/sample`` directory to any place of your choosing.
You can place it anywhere you like. Rename the directory to match the name
of your project.
-#. If you downloaded LLVM using Subversion, remove all the directories named
+2. If you downloaded LLVM using Subversion, remove all the directories named
``.svn`` (and all the files therein) from your project's new source tree.
This will keep Subversion from thinking that your project is inside
``llvm/trunk/projects/sample``.
-#. Add your source code and Makefiles to your source tree.
+3. Add your source code and Makefiles to your source tree.
-#. If you want your project to be configured with the ``configure`` script then
+4. If you want your project to be configured with the ``configure`` script then
you need to edit ``autoconf/configure.ac`` as follows:
- * **``AC_INIT``** — Place the name of your project, its version number
- and a contact email address for your project as the arguments to this macro
+ * **AC_INIT** - Place the name of your project, its version number and a
+ contact email address for your project as the arguments to this macro
- * **``AC_CONFIG_AUX_DIR``** — If your project isn't in the
- ``llvm/projects`` directory then you might need to adjust this so that it
- specifies a relative path to the ``llvm/autoconf`` directory.
-
- * **``LLVM_CONFIG_PROJECT``** — Just leave this alone.
+ * **AC_CONFIG_AUX_DIR** - If your project isn't in the ``llvm/projects``
+ directory then you might need to adjust this so that it specifies a
+ relative path to the ``llvm/autoconf`` directory.
- * **``AC_CONFIG_SRCDIR``** — Specify a path to a file name that
- identifies your project; or just leave it at ``Makefile.common.in``.
+ * **LLVM_CONFIG_PROJECT** - Just leave this alone.
- * **``AC_CONFIG_FILES``** — Do not change.
+ * **AC_CONFIG_SRCDIR** - Specify a path to a file name that identifies your
+ project; or just leave it at ``Makefile.common.in``.
- * **``AC_CONFIG_MAKEFILE``** — Use one of these macros for each
- Makefile that your project uses. This macro arranges for your makefiles to
- be copied from the source directory, unmodified, to the build directory.
+ * **AC_CONFIG_FILES** - Do not change.
-#. After updating ``autoconf/configure.ac``, regenerate the configure script
- with these commands:
+ * **AC_CONFIG_MAKEFILE** - Use one of these macros for each Makefile that
+ your project uses. This macro arranges for your makefiles to be copied from
+ the source directory, unmodified, to the build directory.
-.. code-block:: bash
+5. After updating ``autoconf/configure.ac``, regenerate the configure script
+ with these commands. (You must be using ``Autoconf`` version 2.59 or later
+ and your ``aclocal`` version should be 1.9 or later.)
- % cd autoconf
- % ./AutoRegen.sh
+ .. code-block:: bash
- You must be using Autoconf version 2.59 or later and your ``aclocal`` version
- should be 1.9 or later.
+ % cd autoconf
+ % ./AutoRegen.sh
-#. Run ``configure`` in the directory in which you want to place object code.
+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:
``--with-llvmsrc=<directory>``
``--prefix=<directory>``
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.
Underneath your top level directory, you should have the following directories:
-**``lib``**
+**lib**
This subdirectory should contain all of your library source code. For each
- library that you build, you will have one directory in **``lib``** that will
+ library that you build, you will have one directory in **lib** that will
contain that library's source code.
- Libraries can be object files, archives, or dynamic libraries. The
- **``lib``** directory is just a convenient place for libraries as it places
- them all in a directory from which they can be linked later.
+ Libraries can be object files, archives, or dynamic libraries. The **lib**
+ directory is just a convenient place for libraries as it places them all in
+ a directory from which they can be linked later.
-**``include``**
+**include**
This subdirectory should contain any header files that are global to your
project. By global, we mean that they are used by more than one library or
executable of your project.
- By placing your header files in **``include``**, they will be found
+ By placing your header files in **include**, they will be found
automatically by the LLVM build system. For example, if you have a file
- **``include/jazz/note.h``**, then your source files can include it simply
- with **``#include "jazz/note.h"``**.
+ **include/jazz/note.h**, then your source files can include it simply with
+ **#include "jazz/note.h"**.
-**``tools``**
+**tools**
This subdirectory should contain all of your source code for executables.
- For each program that you build, you will have one directory in
- **``tools``** that will contain that program's source code.
+ For each program that you build, you will have one directory in **tools**
+ that will contain that program's source code.
-**``test``**
+**test**
This subdirectory should contain tests that verify that your code works
correctly. Automated tests are especially useful.
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 <CommandGuide/lit>` testing tool. This test procedure uses ``RUN``
lines in the actual test case to determine how to run the test. See the
- `TestingGuide`_TestingGuide.html 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
testing harness. You will simply need to find a way to use the source
provided within that directory on your own.
-Typically, you will want to build your **``lib``** directory first followed by
-your **``tools``** directory.
+Typically, you will want to build your **lib** directory first followed by your
+**tools** directory.
Writing LLVM Style Makefiles
============================
This variable holds a space separated list of libraries that should be
linked into the program. These libraries must be libraries that come from
- your **``lib``** directory. The libraries must be specified without their
+ your **lib** directory. The libraries must be specified without their
``lib`` prefix. For example, to link ``libsample.a``, you would set
``USEDLIBS`` to ``sample.a``.
``LIBS``
- To link dynamic libraries, add <tt>-l<library base name></tt> 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<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.
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``.
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
Libraries
All libraries (static and dynamic) will be stored in
- ``PROJ_OBJ_ROOT/<type>/lib``, where *``type``* is ``Debug``, ``Release``, or
+ ``PROJ_OBJ_ROOT/<type>/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/<type>/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/<type>/bin``, where *type*
+ is ``Debug``, ``Release``, or ``Profile`` for a debug, optimized, or
+ profiled build, respectively.
Further Help
============
If you have any questions or need any help creating an LLVM project, the LLVM
team would be more than happy to help. You can always post your questions to
-the `LLVM Developers Mailing List`_http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev.
+the `LLVM Developers Mailing List
+<http://lists.cs.uiuc.edu/pipermail/llvmdev/>`_.
projects / oota-llvm.git / blobdiff