. H1 ... doc_title H2 ... doc_section H3 ... doc_subsection H4 ... doc_subsubsection git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129736 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/MakefileGuide.html | 82 ++++++++++++++++++++++++------------------------- 1 file changed, 40 insertions(+), 42 deletions(-) (limited to 'docs/MakefileGuide.html') diff --git a/docs/MakefileGuide.html b/docs/MakefileGuide.html index f50e335..a85314a 100644 --- a/docs/MakefileGuide.html +++ b/docs/MakefileGuide.html @@ -7,7 +7,7 @@ -

LLVM Makefile Guide

Introduction

General Concepts

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 @@ -129,7 +129,7 @@

Variable Values

To use the makefile system, you simply create a file named Makefile in your directory and declare values for certain variables. @@ -139,7 +139,7 @@

Including Makefiles

Setting variables alone is not enough. You must include into your Makefile additional files that provide the rules of the LLVM Makefile system. The @@ -147,7 +147,7 @@

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 @@ -163,8 +163,7 @@

Makefile.common

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

@@ -182,8 +181,7 @@

Makefile.config

Every project must have a Makefile.config at the top of its build directory. This file is generated by the @@ -196,7 +194,7 @@

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 @@ -206,7 +204,7 @@

Comments

User Makefiles need not have comments in them unless the construction is unusual or it does not strictly follow the rules and patterns of the LLVM @@ -216,7 +214,7 @@

Tutorial

This section provides some examples of the different kinds of modules you @@ -226,7 +224,7 @@

Libraries

Only a few variable definitions are needed to build a regular library. Normally, the makefile system will build all the software into a single @@ -259,7 +257,7 @@

Bitcode Modules

In some situations, it is desirable to build a single bitcode module from a variety of sources, instead of an archive, shared library, or bitcode @@ -280,9 +278,9 @@

In some situations, you need to create a loadable module. Loadable modules can be loaded into programs like opt or llc to specify @@ -312,7 +310,7 @@

Tools

For building executable programs (tools), you must provide the name of the tool and the names of the libraries you wish to link with the tool. For @@ -347,7 +345,7 @@

JIT Tools

Many tools will want to use the JIT features of LLVM. To do this, you simply specify that you want an execution 'engine', and the makefiles will @@ -368,7 +366,7 @@

Targets Supported

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 @@ -440,14 +438,14 @@

all-local

This target is the same as all but it operates only on the current directory instead of recursively.

check

This target can be invoked from anywhere within a project's directories but always invokes the check-local target @@ -464,7 +462,7 @@

check-local

This target should be implemented by the Makefile in the project's test directory. It is invoked by the check target elsewhere. @@ -475,7 +473,7 @@

clean

This target cleans the build directory, recursively removing all things that the Makefile builds. The cleaning rules have been made guarded so they @@ -484,14 +482,14 @@

clean-local

This target does the same thing as clean but only for the current (local) directory.

dist

This target builds a distribution tarball. It first builds the entire project using the all target and then tars up the necessary files and @@ -500,7 +498,7 @@

dist-check

This target does the same thing as the dist target but also checks the distribution tarball. The check is made by unpacking the tarball to a new @@ -512,7 +510,7 @@

dist-clean

This is a special form of the clean clean target. It performs a normal clean but also removes things pertaining to building the @@ -520,7 +518,7 @@

install

This target finalizes shared objects and executables and copies all libraries, headers, executables and documentation to the directory given @@ -538,7 +536,7 @@

preconditions

This utility target checks to see if the Makefile in the object directory is older than the Makefile in the source directory and @@ -549,14 +547,14 @@

printvars

This utility target just causes the LLVM makefiles to print out some of the makefile variables so that you can double check how things are set.

reconfigure

This utility target will force a reconfigure of LLVM or your project. It simply runs $(PROJ_OBJ_ROOT)/config.status --recheck to rerun the @@ -566,7 +564,7 @@

spotless

This utility target, only available when $(PROJ_OBJ_ROOT) is not the same as $(PROJ_SRC_ROOT), will completely clean the @@ -578,7 +576,7 @@