From 1fdc95c2392a2c5e4ad3e59e941ef9fa76d13835 Mon Sep 17 00:00:00 2001 From: Reid Spencer Date: Sat, 30 Oct 2004 21:39:42 +0000 Subject: [PATCH] Complete the description of public variables. Internal variables are listed but not described. It might just stay that way. llvm-svn: 17363 --- llvm/docs/MakefileGuide.html | 492 +++++++++++++++++++++++++---------- 1 file changed, 357 insertions(+), 135 deletions(-) diff --git a/llvm/docs/MakefileGuide.html b/llvm/docs/MakefileGuide.html index b72c8e129d6c..4d7e1c4a2cd6 100644 --- a/llvm/docs/MakefileGuide.html +++ b/llvm/docs/MakefileGuide.html @@ -43,6 +43,7 @@
  • Control Variables
  • Override Variables
  • Readable Variables
    • +
  • Internal Variables
    • @@ -51,8 +52,6 @@

    Written by Reid Spencer

    -

    WARNING: This document is a work in progress!

    -
    Introduction
    @@ -207,6 +206,9 @@ installall Copy built objects to installation directory. + printvarsall + Prints variables defined by the makefile system (for debugging). + tags Make C and C++ tags files for emacs and vi. @@ -247,7 +249,6 @@ 0 then the check succeeds, otherwise not. The programs run can be anything but they should either be local to the directory or in your path.

    -

    Not implemented yet!

    check-local
    @@ -255,7 +256,6 @@

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

    -

    Not implemented yet!

    clean
    @@ -280,7 +280,6 @@ compresses it. The generated tarball is sufficient for a casual source distribution, but probably not for a release (see dist-check).

    -

    Not implemented yet!

    dist-check
    @@ -293,7 +292,6 @@ goes out to make sure that the distributed tarball can actually be built into a working release.

    -

    Not implemented yet!

    dist-clean
    @@ -302,7 +300,6 @@ normal clean but also removes things pertaining to building the distribution.

    -

    Not implemented yet!

    install
    @@ -343,7 +340,11 @@

    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 + obtain information from it. Variables are also used internally by the LLVM + Makefile System. Variable names that contain only the upper case alphabetic + letters and underscore are intended for use by the end user. All other + variables are internal to the LLVM Makefile System and should not be relied + upon nor modified. The sections below describe how to use the LLVM Makefile variables.

    @@ -354,98 +355,214 @@ 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_SOURCESSpecifies 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.
    EXPERIMENTAL_DIRSSpecify a set of directories that should be built, but if they fail, - it should not cause the build to fail. Note that this should only be - used temporarily while code is being written.
    OPTIONAL_DIRSSpecify a set of directories that may be built, if they exist, but its - not an error for them not to exist.
    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.
    +
    +
    BUILD_ARCHIVE
    +
    If set to any value, causes an archive (.a) library to be built.
    +
    BUILT_SOURCES
    +
    Specifies a set of source files that are generated from other source + files. These sources will be built before any other target processing to + ensure they are present. +
    BYTECODE_LIBRARY
    +
    If set to any value, causes a bytecode library (.bc) to be built.
    +
    CONFIG_FILES
    +
    Specifies a set of configuration files to be installed.
    +
    DIRS
    +
    Specifies a set of directories, usually children of the current + directory, that should also be made using the same goal. These directories + will be built serially.
    +
    DISABLE_AUTO_DEPENDENCIES
    +
    If set to any value, causes the makefiles to not automatically + generate dependencies when running the compiler. Use of this feature is + discouraged and it may be removed at a later date.
    +
    DONT_BUILD_RELINKED
    +
    If set to any value, causes a relinked library (.o) not to be built. By + default, libraries are built as re-linked since most LLVM libraries are + needed in their entirety and re-linked libraries will be linked more quickly + than equival archive libraries.
    +
    ENABLE_OPTIMIZED
    +
    If set to any value, causes the build to generate optimized objects, + libraries and executables. This alters the flags specified to the compilers + and linkers. Generally debugging won't be a fun experience with an optimized + build.
    +
    ENABLE_PROFILING
    +
    If set to any value, causes the build to generate both optimized and + profiled objects, libraries and executables. This alters the flags specified + to the compilers and linkers to ensure that profile data can be collected + from the tools built. Use the gprof tool to analyze the output from + the profiled tools (gmon.out).
    +
    EXPERIMENTAL_DIRS
    +
    Specify a set of directories that should be built, but if they fail, it + should not cause the build to fail. Note that this should only be used + temporarily while code is being written.
    +
    EXPORTED_SYMBOL_FILE
    +
    Specifies the name of a single file that contains a list of the + symbols to be exported by the linker. One symbol per line.
    +
    EXPORTED_SYMBOL_LIST
    +
    Specifies a set of symbols to be exported by the linker.
    +
    EXTRA_DIST
    +
    Specifies additional files that should be distributed with LLVM. All + source files, all built sources, all Makefiles, and most documentation files + will be automatically distributed. Use this variable to distribute any + files that are not automatically distributed.
    +
    KEEP_SYMBOLS
    +
    If set to any value, specifies that when linking executables the + makefiles should retain debug symbols in the executable. Normally, symbols + are stripped from the executable.
    +
    LEVEL(required)
    +
    Specify the level of nesting from the top level. This variable must be + set in each makefile as it is used to find the top level and thus the other + makefiles.
    +
    LIBRARYNAME
    +
    Specify the name of the library to be built. (Required For Libraries)
    + BUILD_OBJ_DIR directory. +
    LLVMLIBS
    +
    Specifies the set of libraries from the LLVM $(ObjDir) that will be + linked into the tool or library.
    +
    OPTIONAL_DIRS
    +
    Specify a set of directories that may be built, if they exist, but its + not an error for them not to exist.
    +
    PARALLEL_DIRS
    +
    Specify a set of directories to build recursively and in parallel if + the -j option was used with make.
    +
    SHARED_LIBRARY
    +
    If set to any value, causes a shared library (.so) to be built in + addition to any other kinds of libraries. Note that this option will cause + all source files to be built twice: once with options for position + independent code and once without. Use it only where you really need a + shared library.
    +
    SOURCES(optional) +
    Specifies the list of source files in the current directory to be + built. Source files of any type may be specified (programs, documentation, + config files, etc.). If not specified, the makefile system will infer the + set of source files from the files present in the current directory.
    +
    SUFFIXES
    +
    Specifies a set of filename suffixes that occur in suffix match rules. + Only set this if your local Makefile specifies additional suffix + match rules.
    +
    TARGET
    +
    Specifies the name of the LLVM code generation target that the + current directory builds. Setting this variable enables additional rules to + build .inc files from .td files.
    +
    TOOLNAME
    +
    Specifies the name of the tool that the current directory should + build.
    +
    USEDLIBS +
    Specifies the list of project libraries that will be linked into the + tool or library.
    +
    VERBOSE +
    Tells the Makefile system to produce detailed output of what it is doing + instead of just summary comments. This will generate a LOT of output.
    +
    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).
    +

    Overridable variables can be used to override the default + values provided by the LLVM makefile system. These variables can be set in + several ways:

    +
      +
    • In the environment (e.g. setenv, export) -- not recommended.
      • +
    • On the make command line -- recommended.
      • +
    • On the configure command line
      • +
    • In the Makefile (only after the inclusion of $(LEVEL)/Makefile.common.
      • +
    +

    The overridable variables are given below:

    +
    +
    AR (defaulted)
    +
    Specifies the path to the ar tool.
    +
    BISON(configured)
    +
    Specifies the path to the bison tool.
    +
    BUILD_OBJ_DIR
    +
    The directory into which the products of build rules will be placed. + This might be the same as + BUILD_SRC_DIR but typically is + not.
    +
    BUILD_SRC_DIR
    +
    The directory which contains the source files to be built.
    +
    BURG
    +
    Specifies the path to the burg tool.
    +
    BZIP2(configured)
    +
    The path to the bzip2 tool.
    +
    CC(configured)
    +
    The path to the 'C' compiler.
    +
    CFLAGS
    +
    Additional flags to be passed to the 'C' compiler.
    +
    CXX
    +
    Specifies the path to the C++ compiler.
    +
    CXXFLAGS
    +
    Additional flags to be passed to the C++ compiler.
    +
    DATE(configured)
    +
    Specifies the path to the date program or any program that can + generate the current date and time on its standard output
    +
    DOT(configured)
    +
    Specifies the path to the dot tool or false if there + isn't one.
    +
    ECHO(configured)
    +
    Specifies the path to the echo tool for printing output.
    +
    ETAGS(configured)
    +
    Specifies the path to the etags tool.
    +
    ETAGSFLAGS(configured)
    +
    Provides flags to be passed to the etags tool.
    +
    EXEEXT(configured)
    +
    Provides the extension to be used on executables built by the makefiles. + The value may be empty on platforms that do not use file extensions for + executables (e.g. Unix).
    +
    FLEX(configured)
    +
    Specifies the path to the flex tool.
    +
    GCCLD(defaulted)
    +
    Specifies the path to the gccld tool.
    +
    HAVE_BZIP2(configured)
    +
    This variable is set automatically if the configure script + could find the bzip2 library.
    +
    HAVE_ZLIB(configured)
    +
    This variable is set automatically if the configure script + could find the zlib library.
    +
    INSTALL(configured)
    +
    Specifies the path to the install tool.
    +
    LDFLAGS(configured)
    +
    Allows users to specify additional flags to pass to the linker.
    +
    LIBS(configured)
    +
    The list of libraries that should be linked with each tool.
    +
    LIBTOOL(configured)
    +
    Specifies the path to the libtool tool. This tool is renamed + mklib by the configure script and always located in the +
    LLVMAS(defaulted)
    +
    Specifies the path to the llvm-as tool.
    +
    LLVMGCC(defaulted)
    +
    Specifies the path to the LLVM version of the GCC 'C' Compiler
    +
    LLVMGXX(defaulted)
    +
    Specifies the path to the LLVM version of the GCC C++ Compiler
    +
    LLVM_OBJ_ROOT(configured)
    +
    Specifies the top directory into which the output of the build is + placed.
    +
    LLVM_SRC_ROOT(configured)
    +
    Specifies the top directory in which the sources are found.
    +
    LLVM_TARBALL_NAME(configured)
    +
    Specifies the name of the distribution tarball to create. This is + configured from the name of the project and its version number.
    +
    MKDIR(defaulted)
    +
    Specifies the path to the mkdir tool that creates + directories.
    +
    PLATFORMSTRIPOPTS
    +
    The options to provide to the linker to specify that a stripped (no + symbols) executable should be built.
    +
    RANLIB(defaulted)
    +
    Specifies the path to the ranlib tool.
    +
    RM(defaulted)
    +
    Specifies the path to the rm tool.
    +
    SED(defaulted)
    +
    Specifies the path to the sed tool.
    +
    SHLIBEXT(configured)
    +
    Provides the filename extension to use for shared libraries.
    +
    TBLGEN(defaulted)
    +
    Specifies the path to the tblgen tool.
    +
    TAR(defaulted)
    +
    Specifies the path to the tar tool.
    +
    ZIP(defaulted)
    +
    Specifies the path to the zip tool.
    +
    @@ -454,46 +571,151 @@

    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 containing the directories source files.
    BUILD_OBJ_DIRThe project directory that will receive the object files.
    CONFIGURATIONThe name of the configuration being built.
    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.
    +
    +
    bindir
    +
    The directory into which executables will ultimately be installed. This + value is derived from the --prefix option given to + configure.
    +
    bytecode_libdir
    +
    The directory into which bytecode libraries will ultimately be installed. + This value is derived from the --prefix option given to + configure.
    +
    ConfigureScriptFLAGS
    +
    Additional flags given to the configure script when + reconfiguring.
    +
    DistDir
    +
    The current directory for which a distribution copy is being + made.
    +
    Echo
    +
    The LLVM Makefile System output command. This provides the + llvm[n] prefix and starts with @ so the command itself is not + printed by make.
    +
    EchoCmd
    +
    Same as Echo but without the leading @. +
    +
    includedir
    +
    The directory into which include files will ultimately be installed. + This value is derived from the --prefix option given to + configure.
    +
    libdir
    +
    The directory into which native libraries will ultimately be installed. + This value is derived from the --prefix option given to + configure.
    +
    LibDir
    +
    The configuration specific directory into which libraries are placed + before installation.
    +
    MakefileConfig
    +
    Full path of the Makefile.config file.
    +
    MakefileConfigIn
    +
    Full path of the Makefile.config.in file.
    +
    ObjDir
    +
    The configuration and directory specific directory where build objects + (compilation results) are placed.
    +
    SubDirs
    +
    The complete list of sub-directories of the current directory as + specified by other variables.
    +
    Sources
    +
    The complete list of source files.
    +
    sysconfdir
    +
    The directory into which configuration files will ulitmately be + installed. This value is derived from the --prefix option given to + configure.
    +
    ToolDir
    +
    The configuration specific directory into which executables are placed + before they are installed.
    +
    TopDistDir
    +
    The top most directory into which the distribution files are copied.
    +
    Verb
    +
    Use this as the first thing on your build script lines to enable or + disable verbose mode. It expands to either an @ (quiet mode) or nothing + (verbose mode).
    +
    + + + +
    Internal Variables
    +
    +

    Variables listed below are used by the LLVM Makefile System + and considered internal. You should not use these variables under any + circumstances.

    +
    +
    Archive
    +
    AR.Flags
    +
    BaseNameSources
    +
    BCCompile.C
    +
    BCCompile.CXX
    +
    BCLinkLib
    +
    Burg
    +
    C.Flags
    +
    Compile.C
    +
    CompileCommonOpts
    +
    Compile.CXX
    +
    ConfigStatusScript
    +
    Configuration
    +
    ConfigureScript
    +
    CPP.Flags
    +
    CPP.Flags
    +
    CXX.Flags
    +
    DependFiles
    +
    DestArchiveLib
    +
    DestBytecodeLib
    +
    DestRelinkedLib
    +
    DestSharedLib
    +
    DestTool
    +
    DistAlways
    +
    DistCheckDir
    +
    DistCheckTop
    +
    DistFiles
    +
    DistName
    +
    DistOther
    +
    DistSources
    +
    DistSubDirs
    +
    DistTarBZ2
    +
    DistTarGZip
    +
    DistZip
    +
    ExtraLibs
    +
    INCFiles
    +
    InternalTargets
    +
    LD.Flags
    +
    LexOutput
    +
    LibName.A
    +
    LibName.BC
    +
    LibName.LA
    +
    LibName.O
    +
    LibTool.Flags
    +
    Link
    +
    LLVMGCCLibDir
    +
    LLVMLibDir
    +
    LLVMLibsOptions
    +
    LLVMLibsPaths
    +
    LLVMToolDir
    +
    LLVMUsedLibs
    +
    LocalTargets
    +
    LTCompile.C
    +
    LTCompile.CXX
    +
    LTInstall
    +
    ObjectsBC
    +
    ObjectsLO
    +
    ObjectsO
    +
    ObjMakefiles
    +
    Parallel_Targets
    +
    PreConditions
    +
    ProjLibsOptions
    +
    ProjLibsPaths
    +
    ProjUsedLibs
    +
    Ranlib
    +
    RecursiveTargets
    +
    Relink
    +
    SrcMakefiles
    +
    Strip
    +
    StripWarnMsg
    +
    TableGen
    +
    TDFiles
    +
    ToolBuildPath
    +
    TopLevelTargets
    +
    UserTargets
    +
    YaccOutput
    +