summaryrefslogtreecommitdiffstats
path: root/docs/Projects.rst
diff options
context:
space:
mode:
authorRafael Espindola <rafael.espindola@gmail.com>2014-03-12 22:40:22 +0000
committerRafael Espindola <rafael.espindola@gmail.com>2014-03-12 22:40:22 +0000
commit9802a6cbdc2ddcb445fc8620fd756654de6d85b4 (patch)
tree3aaa6a28cdc4233c55a7d8084796af305455cc21 /docs/Projects.rst
parent1da4b5ba045bd9d4c9c3760ca53101042d157ce4 (diff)
Remove projects/sample.
As an example that was not actually being used, it suffered from a slow bitrot. The two main issues with it were that it had no cmake support and included a copy of the autoconf directory. The reality is that autoconf is not easily composable. The lack of composabilty is why we have clang options in llvm's configure. Suggesting that users include a copy of autoconf/ in their projects seems a bad idea. We are also in the process of switching to cmake, so pushing autoconf to new project is probably not what we want. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@203728 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/Projects.rst')
-rw-r--r--docs/Projects.rst74
1 files changed, 4 insertions, 70 deletions
diff --git a/docs/Projects.rst b/docs/Projects.rst
index 3246e3ff169b..095b87a65a10 100644
--- a/docs/Projects.rst
+++ b/docs/Projects.rst
@@ -37,82 +37,16 @@ There are two ways that you can set all of these variables:
of LLVM, and the ability to support multiple object directories from a single
source directory.
-This document assumes that you will base your project on the LLVM sample project
-found in ``llvm/projects/sample``. If you want to devise your own build system,
-studying the sample project and LLVM ``Makefiles`` will probably provide enough
-information on how to write your own ``Makefiles``.
-
-Create a Project from the Sample Project
-========================================
-
-Follow these simple steps to start your project:
-
-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.
-
-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``.
-
-3. Add your source code and Makefiles to your source tree.
-
-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_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_SRCDIR** - Specify a path to a file name that identifies your
- project; or just leave it at ``Makefile.common.in``.
-
- * **AC_CONFIG_FILES** - Do not change.
-
- * **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.
-
-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.)
-
- .. code-block:: bash
-
- % 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:
-
- ``--with-llvmsrc=<directory>``
- Tell your project where the LLVM source tree is located.
-
- ``--with-llvmobj=<directory>``
- Tell your project where the LLVM object tree is located.
-
- ``--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 you're on a
-GNU/Linux system) in the root of your object directory, and your project should
-build.
+If you want to devise your own build system, studying other projects and LLVM
+``Makefiles`` will probably provide enough information on how to write your own
+``Makefiles``.
Source Tree Layout
==================
In order to use the LLVM build system, you will want to organize your source
code so that it can benefit from the build system's features. Mainly, you want
-your source tree layout to look similar to the LLVM source tree layout. The
-best way to do this is to just copy the project tree from
-``llvm/projects/sample`` and modify it to meet your needs, but you can certainly
-add to it if you want.
+your source tree layout to look similar to the LLVM source tree layout.
Underneath your top level directory, you should have the following directories: