diff --git a/llvm/docs/MakefileGuide.html b/llvm/docs/MakefileGuide.html new file mode 100644 index 000000000000..f7cf48faddc7 --- /dev/null +++ b/llvm/docs/MakefileGuide.html @@ -0,0 +1,458 @@ + + + + + LLVM Makefile Guide + + + + +
LLVM Makefile Guide
+ +
    +
  1. Introduction
    2. +
  2. General Concepts +
      +
    1. Projects
      2. +
    2. Makefile
      3. +
    3. Makefile.common
      4. +
    4. Makefile.config
      5. +
    5. Makefil.rules
      6. +
    6. Comments
      7. +
    +
    3. +
  3. Targets Supported +
      +
    1. all
      2. +
    2. all-local
      3. +
    3. check
      4. +
    4. check-local
      5. +
    5. clean
      6. +
    6. clean-local
      7. +
    7. dist
      8. +
    8. dist-check
      9. +
    9. dist-clean
      10. +
    10. install
      11. +
    11. tags
      12. +
    12. uninstall
      13. +
    +
    4. +
  4. Using Variables +
      +
    1. Control Variables
      2. +
    2. Override Variables
      3. +
    3. Readable Variables
      4. +
    +
    5. +
+ +
+

Written by Reid Spencer

+
+ + +
Introduction
+ + +
+

This document provides usage information about the LLVM makefile + system. While loosely patterned after the BSD makefile system, LLVM has taken + a deparature from BSD in order to implement additional features needed by LLVM. +

+

Although makefile systems such as automake were attempted at one point, it + has become clear that the variations requried by LLVM from any Makefle norm + are too many to strictly use a more limited tool. Consequently, LLVM requires + simply GNU Make 3.79, a widely portably makefile processor. LLVM unabashedly + makes heavy use of the features of GNU Make so the dependency on GNU Make is + firm. If you're not familiar with make, it is recommended that you + read the + GNU Makefile Manual.

+

While this document is rightly part of the + LLVM Programmer's Manual, it is treated + separately here because of the volume of content and because it is often an + early source of bewilderment for new developers.

+
+ + +
General Concepts
+ + +
+

The LLVM makefile system is the component of LLVM that is responsible for + building the software, testing it, generating distributions, rpms and other + packages, installing and uninstalling, etc.

+
+ + +
Projects
+
+

The LLVM Makefile System is quite generous. It not only builds its own + software, but it can build yours too. Built into the system is knowledge of + the llvm/projects directory. Any directory under projects + that has both a configure script and a Makefile is assumed + to be a project that uses the LLVM Makefile system. This allows your project + to get up and running quickly by utilizing the built-in features that are used + to compile LLVM.

+
+ + +
Makefile
+
+

Each directory to participate in the build needs to have a file named + Makefile. This is the file first read by make. It has three + sections:

+
    +
  1. Settable Variables - Required that must be set + first.
    2. +
  2. include $(LEVEL)/Makefile.common + - include the LLVM Makefile system. +
  3. Overridable Variables - Override variables set by + the LLVM Makefile system. +
+
+ + +
Makefile.common
+
+

Every project must have a Makefile.common file at its top source + directory. This file serves three purposes:

+
    +
  1. It includes the project's configuration makefile to obtain values + determined by the configure script. This is done by including the + $(LEVEL)/Makefile.config file.
    2. +
  2. It specifies any other (static) values that are needed throughout the + project. Only values that are used in all or a large proportion of the + project's directories should be placed here.
    3. +
  3. It include's the standard rules for the LLVM Makefile system, + $(LLVM_SRC_ROOT)/Makefile.rules. + This file is the "guts" of the LLVM Makefile system.
    4. +
+
+ + +
Makefile.config
+
+

Every project must have a Makefile.config at the top of its + build directory. This file is generated by the + configure script from the pattern provided by the + Makefile.config.in file located at the top of the project's + source directory. The contents of this file depend largely on what + configuration items the project uses, however most projects can get what they + need by just relying on LLVM's configuration found in + $(LLVM_OBJ_ROOT)/Makefile.config. +

+ + +
Makefile.rules
+
+

This file, located at $(LLVM_SRC_ROOT)/Makefile.rules is the heart + of the LLVM Makefile System. It provides all the logic, dependencies, and + rules for building the targets supported by the system. What it does largely + depends on the values of make variables that + have been set before Makefile.rules is included. +

+ + +
Comments
+
+

User Makefiles need not have comments in them unless the construction is + unusual or it doesn't strictly follow the rules and patterns of the LLVM + makefile system. Makefile comments are invoked with the pound (#) character. + The # character and any text following it, to the end of the line, are ignored + by make.

+
+ + +
Targets Supported
+ + +
+

This section describes each of the targets that can be built using the LLVM + Makefile system. Any target can be invoked from any directory but not all are + applicabe to a given directory (e.g. "dist" and "install" will always operate + as if invoked from the top level directory).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Target NameImplied TargetsTarget Description
allCompile the software recursively. Default target. +
all-localCompile the software in the local directory only. +
checkallTest the software recursively. +
check-localall-localTest the software in the local directory only. +
cleanRemove built objects recursively. +
clean-localRemove built objects from the local directory only. +
distallPrepare a source distribution tarball. +
dist-checkall checkPrepare a source distribution tarball and check that it builds. +
dist-cleancleanClean source distribution tarball temporary files. +
installallCopy built objects to installation directory. +
tagsMake C and C++ tags files for emacs and vi. +
uninstallRemove built objects from installation directory. +
+
+ + +
all (default)
+
+

When you invoke make with no arguments, you are implicitly + instructing it to seek the "all" target (goal). This target is used for + building the software and will do different things in different directories. + For example, in a lib directory, the "all" target will compile source + files and generate libraries. But, in a tools directory, it will link + libraries and generate executables.

+
+ + +
all-local
+
+

TBD

+
+ + +
check
+
+

TBD

+
+ + +
check-local
+
+

TBD

+
+ + +
clean
+
+

TBD

+
+ + +
clean-local
+
+

TBD

+
+ + +
dist
+
+

TBD

+
+ + +
dist-check
+
+

TBD

+
+ + +
dist-clean
+
+

TBD

+
+ + +
install
+
+

TBD

+
+ +
tags
+
+

TBD

+
+ + +
uninstall
+
+

TBD

+
+ + +
Variables
+ +
+

Variables are used to tell the LLVM Makefile System what to do and to + obtain information from it. The sections below describe the three kinds of + variables.

+
+ + +
Control Variables
+
+

Variables listed in the table below should be set before the + inclusion of $(LEVEL)/Makefile.common. + These variables provide input to the LLVM make system that tell it what to do + for the current directory.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Variable NameVariable Description
BUILD_ARCHIVEIf set to any value, causes an archive (.a) library to be built.
BUILT_SOURCESSpecifies a set of source files that are generated. These will be + built before any other target processing to ensure they are present.
BUILT_SOURCESIf set to any value, causes a bytecode library (.bc) to be built.
BUILT_SOURCESSpecivies a set of configuration files to be installed.
DIRSSpecifies a set of directories that should also be made using the + same goal. These directories will be built serially.
DONT_BUILD_RELINKEDIf set to any value, causes a relinked library (.o) not to be built.
EXPORTED_SYMBOL_FILESpecifies the name of a single file that contains a list of the + symbols to be exported by the linker. One symbol per line.
LEVELSpecify the level of nesting from the top level. (Required)
LIBRARYNAMESpecify the name of the library to be built. (Required For Libraries)
LLVMLIBSSpecify the set of libraries from the LLVM $(OBJDIR) that will be + linked into the tool or library.
OPTIONAL_DIRSSpecify a set of directories that may be built, but if they don't + build, the recursive make doesn't stop.
PARALLEL_DIRSSpecify a set of directories to build recursively and in parallel if + the -j option was used with make.
SHARED_LIBRARYIf set to any value, causes a shared library (.so) to be built. + (Optional)
SOURCESSpecifies the list of source files in the current directory to be + acted upon. Source files of any type may be specified (programs, + documentation, config files, etc.)
TARGETSpecifies the name of the LLVM code generation target that the + current directory builds.
TOOLNAMESpecifies the name of the tool to build. (Required For Tools)
USEDLIBSSpecifies the list of project libraries that will be linked into the + tool or library.
+
+ + +
Overridable Variables
+
+

Variables listed in the table below can be used to override the default + values provided by the LLVM makefile system. These variables should be set + after the inclusion of $(LEVEL)/Makefile.common.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Variable NameVariable Description
CThe name (and optional path) of the 'C' compiler (gcc normally).
CFLAGSThe set of options to be passed to the 'C' compiler on every + compile.
CPPThe name (and optional path) of the 'C' pre-processor (cpp normally). +
CXXThe name (and optional path) of the C++ compiler (g++ normally).
LDThe name (and optional path) of the system linker (gcc normally).
LIBTOOLThe name (and optional path) of the libtool tool (libtool normally).
+
+ + +
Readable Variables
+
+

Variables listed in the table below can be used by the user's Makefile but + should not be changed. Changing the value will generally cause the build to go + wrong, so don't do it.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Variable NameVariable Description
BUILD_SRC_DIRThe project directory contaning the directories source files.
BUILD_OBJ_DIRThe project directory that will receive the object files.
DESTDIRThe top level directory into which files are installed.
LLVM_SRC_ROOTThe top level directory of the LLVM source.
LLVM_OBJ_ROOTThe top level directory of the LLVM objects.
OBJDIRThe directory in which the project's object files should be placed.
LIBDIRThe directory in which the project's library files should be placed.
TOOLDIRThe directory in which the project's executable tools should be + placed.
+
+ + +
+
+ Valid CSS! + Valid HTML 4.01! + + Reid Spencer
+ The LLVM Compiler Infrastructure
+ Last modified: $Date$ +
+ + + +