6502/llvm-6502
1
0
Fork 0
mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2024-12-13 04:30:23 +00:00
Code Issues Projects Releases Wiki Activity

Update documentation on how to set up a project

Browse Source 
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@19591 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Reid Spencer 2005-01-16 02:21:18 +00:00
parent 11fde54f23
commit 39865c052d
1 changed files with 20 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/Projects.html
View File

@ -40,37 +40,32 @@ projects that use LLVM header files, libraries, and tools. In order to use
these facilities, a Makefile from a project must do the following things:</p> these facilities, a Makefile from a project must do the following things:</p>
<ol> <ol>
<li>Set environment variables.There are several environment variables that a <li>Set <tt>make</tt> variables. There are several variables that a Makefile
Makefile needs to set to use the LLVM build system: needs to set to use the LLVM build system:
<ul>
<ul> <li><tt>PROJECT_NAME</tt> - The name by which your project is known.</li>
<li><tt>LLVM_SRC_ROOT</tt> - The root of the LLVM source tree.</li> <li><tt>LLVM_SRC_ROOT</tt> - The root of the LLVM source tree.</li>
<li><tt>LLVM_OBJ_ROOT</tt> - The root of the LLVM object tree.</li> <li><tt>LLVM_OBJ_ROOT</tt> - The root of the LLVM object tree.</li>
<li><tt>BUILD_SRC_ROOT</tt> - The root of the project's source tree.</li> <li><tt>PROJ_SRC_ROOT</tt> - The root of the project's source tree.</li>
<li><tt>BUILD_OBJ_ROOT</tt> - The root of the project's object tree.</li> <li><tt>PROJ_OBJ_ROOT</tt> - The root of the project's object tree.</li>
<li><tt>BUILD_SRC_DIR</tt> - The directory containing the current source to be <li><tt>PROJ_INSTALL_ROOT</tt> - The root installation directory.</li>
compiled.</li> <li><tt>LEVEL</tt> - The relative path from the current directory to the
<li><tt>BUILD_OBJ_DIR</tt> - The directory where the current source will place project's root ($PROJ_OBJ_ROOT).</li>
the new object files. This should always be the current directory.</li> </ul></li>
<li><tt>LEVEL</tt> - The relative path from the current directory to the root <li>Include <tt>Makefile.config</tt> from <tt>$(LLVM_OBJ_ROOT)</tt>.</li>
of the object tree.</li> <li>Include <tt>Makefile.rules</tt> from <tt>$(LLVM_SRC_ROOT)</tt>.</li>
</ul></li>
<li>Include <tt>Makefile.config</tt> from <tt>$(LLVM_OBJ_ROOT)</tt>.</li>
<li>Include <tt>Makefile.rules</tt> from <tt>$(LLVM_SRC_ROOT)</tt>.</li>
</ol> </ol>
<p>There are two ways that you can set all of these variables:</p> <p>There are two ways that you can set all of these variables:</p>
<ol> <ol>
<li>You can write your own Makefiles which hard-code these values.</li> <li>You can write your own Makefiles which hard-code these values.</li>
<li>You can use the pre-made LLVM sample project. This sample project
<li> You can use the pre-made LLVM sample project. This sample project includes includes Makefiles, a configure script that can be used to configure the
Makefiles, a configure script that can be used to configure the location of location of LLVM, and the ability to support multiple object directories
LLVM, and the ability to support multiple object directories from a single from a single source directory.</li>
source directory.</li>
</ol> </ol>
<p>This document assumes that you will base your project off of the LLVM sample <p>This document assumes that you will base your project on the LLVM sample
project found in <tt>llvm/projects/sample</tt>. If you want to devise your own project found in <tt>llvm/projects/sample</tt>. If you want to devise your own
build system, studying the sample project and LLVM Makefiles will probably build system, studying the sample project and LLVM Makefiles will probably
provide enough information on how to write your own Makefiles.</p> provide enough information on how to write your own Makefiles.</p>