solenv/gbuild/gbuild.help.txt

   1 NAME
   2        gbuild - GNU make based build system for LibreOffice
   3
   4 SYNOPSIS
   5        make [ -f makefile ] [ options ] [ variable=value ... ] [ targets ] ...
   6
   7 IMPORTANT OPTIONS
   8        -s Silent operation; do not print the commands as they are executed.
   9
  10        -n Print the commands that would be executed, but do not execute them.
  11        -k Continue as much as possible after an error.
  12
  13        -j Specifies the number of jobs (commands) to run simultaneously.
  14        -l Specifies that no new jobs (commands) should be started if there are
  15           others jobs running and the load average is at least load.
  16
  17        -t Touch files (mark them up to date without really changing them)
  18           instead of running their commands.
  19        -W Pretend that the target file has just been modified.
  20        -o Do not remake the file file even if it is older than its
  21           dependencies, and do not remake anything on account of changes in file.
  22
  23        -p Print the data base (rules and variable values) that results from
  24           reading the makefiles.
  25        --debug=b debug make run, see GNU make man page for details
  26
  27        (descriptions from GNU make man page)
  28
  29 AVAILABLE TARGETS
  30        all              build product and run unit tests (default goal)
  31        build            build product
  32        unitcheck        run unit tests
  33        slowcheck        run slow unit tests
  34        subsequentcheck  run system tests (requires full installation)
  35        perfcheck        run performance/callgrind unit tests
  36        check            run unit tests and if in toplevel subsequentcheck
  37        clean            remove all generated files
  38        debugrun         starts the INSTDIR instance and allows tests to be run
  39                         against it
  40        dump-deps-png    creates dependency diagrams in PNG format
  41                         NOTE: needs graphviz to work
  42        showmodules      shows all registered modules
  43        <module>         build the named module
  44        <module>.check   run unittests of the named module
  45        <module>.clean   clean the named module
  46        <module>.all     build the named module and the pre-requisite modules for it
  47        <module>.showdeliverables show the targets delivered to INSTDIR and their
  48                         source
  49        cmd              execute the command contained in the variable cmd=""
  50                         in a shell with config_host.mk or config_build.mk
  51                         environment set. (see gb_SIDE)
  52        <target>         build gbuild target (such as Library_vbaswobj or
  53                         CppunitTest_sw_macros_test)
  54        <target>.clean   clean gbuild target
  55        <class>_<target> for all targets and for the following classes:
  56            o AllLangResTarget
  57            o AllLangZip
  58            o CliLibrary
  59            o CliNativeLibrary
  60            o CliUnoApi
  61            o Configuration
  62            o CppunitTest
  63            o CustomTarget
  64            o Dictionary
  65            o Executable
  66            o Extension
  67            o ExternalPackage
  68            o ExternalProject
  69            o Gallery
  70            o Helper
  71            o InstallModule
  72            o InstallScript
  73            o InternalUnoApi
  74            o Jar
  75            o JunitTest
  76            o Library
  77            o Package
  78            o Pagein
  79            o PythonTest_pytests
  80            o Pyuno
  81            o Rdb
  82            o StaticLibrary
  83            o UI
  84            o UnoApi
  85            o UnpackedTarball
  86            o WinResTarget
  87            o Zip
  88
  89 INTERACTIVE VARIABLES:
  90        DEBUG / debug   If not empty, build as with --enable-debug.
  91        ENABLE_SYMBOLS / enable_symbols
  92                        If not empty, build as with --enable-symbols.
  93        DBGLEVEL / dbglevel
  94                        If not empty, force the debug level to the specified value. The
  95                        debug level is passed to the source code through OSL_DEBUG_LEVEL
  96                        macro.
  97                        0 = no debug (as with --disable-debug)
  98                        1 = debugging information + no optimizations (as with --enable-debug)
  99                        (Note that levels higher than 2 are used only by obsolete debugging
 100                        features. Use SAL_INFO/SAL_WARN with a specific area for extra debug
 101                        output in new code.)
 102                        2 = debugging information + no optimizations + extra
 103                            debug output. OSL_TRACE starts being active on this
 104                            level.
 105                        3... = debugging information + no optimizations + extra
 106                               debug output (usually extremely verbose). Levels
 107                               > 2 are not used very much.
 108        PARALLELISM     If not empty, pass argument on as the -j switch
 109                        to recursive make invocations. Useful to
 110                        lower/increase build parallelism individually.
 111        LEXFLAGS        Append flags for LEX scanner generator invocation.
 112        YACCFLAGS       Append flags for YACC parser generator invocation.
 113        CPPFLAGS        Append preprocessor flags for C/C++/ObjC/ObjC++ compilation.
 114        CFLAGS          Override compiler flags for plain C compilation.
 115        ENVCFLAGS       Append compiler flags for plain C compilation.
 116        CXXFLAGS        Override compiler flags for C++ compilation.
 117                        Note: this overrides default optimization and debug
 118                        flags; to append flags without overriding, use:
 119                        CXXFLAGS='$(call gb_LinkTarget__get_debugcxxflags,$(1)) -Wfoo'
 120        ENVCFLAGSCXX    Append compiler flags for C++ compilation.
 121        OBJCFLAGS       Override compiler flags for Objective C compilation.
 122        OBJCXXFLAGS     Override compiler flags for Objective C++ compilation.
 123        LDFLAGS         Override linker flags.
 124        gb_FULLDEPS     Generate and use dependencies (on by default, handle with care).
 125        gb_COLOR        Use ASCII color output.
 126        gb_TITLES       Show progress in terminal title.
 127        gb_Side         Either "host" or "build" (default to "host").
 128                        determine if config_host.mk or config_build.mk is used to
 129                        set the build environment.