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        check            run unit tests and if in toplevel subsequentcheck
  36        clean            remove all generated files
  37        debugrun         starts the dev-install instance and allows tests to be run
  38                         against it
  39        <module>         build the named module
  40        <module>.check   run unittests of the named module
  41        <module>.clean   clean the named module
  42        <module>.all     build the named module and the pre-requisite modules for it
  43        <module>.showdeliverables show the targets delivered to OUTDIR and their
  44                         source
  45        cmd              execute the command contained in the variable cmd=""
  46                         in a shell with config_host.mk or config_build.mk
  47                         environement set. (see gb_SIDE)
  48        <target>         build gbuild target (such as Library_vbaswobj or
  49                         CppunitTest_sw_macros_test)
  50        <target>.clean   clean gbuild target
  51        <class>_<target> for all targets and for the following classes:
  52        o AllLangResTarget
  53        o AllLangZip
  54        o CliLibrary
  55        o CliNativeLibrary
  56        o CliUnoApi
  57        o Configuration
  58        o CppunitTest
  59        o CustomTarget
  60        o Dictionary
  61        o Executable
  62        o Extension
  63        o ExternalPackage
  64        o ExternalProject
  65        o Gallery
  66        o Helper
  67        o InstallModule
  68        o InstallScript
  69        o InternalUnoApi
  70        o Jar
  71        o JunitTest
  72        o Library
  73        o Package
  74        o Pagein
  75        o Pyuno
  76        o Rdb
  77        o StaticLibrary
  78        o UI
  79        o UnoApi
  80        o UnpackedTarball
  81        o WinResTarget
  82        o Zip
  83
  84 INTERACTIVE VARIABLES:
  85        DEBUG / debug   If not empty, build as with --enable-debug.
  86        ENABLE_SYMBOLS / enable_symbols
  87                        If not empty, build as with --enable-symbols.
  88        DBGLEVEL / dbglevel
  89                        If not empty, force the debug level to the specified value. The
  90                        debug level is passed to the source code through OSL_DEBUG_LEVEL
  91                        macro.
  92                        0 = no debug (as with --disable-debug)
  93                        1 = debugging information + no optimizations (as with --enable-debug)
  94                        (Note that levels higher than 2 are used only by obsolete debugging
  95                        features. Use SAL_INFO/SAL_WARN with a specific area for extra debug
  96                        output in new code.)
  97                        2 = debugging information + no optimizations + extra
  98                            debug output. OSL_TRACE starts being active on this
  99                            level.
 100                        3... = debugging information + no optimizations + extra
 101                               debug output (usually extremely verbose). Levels
 102                               > 2 are not used very much.
 103        TIMELOG / timelog
 104                        If not empty enable the RTL_LOGFILE_* time logging facility.
 105                        export RTL_LOGFILE=rtl_logfile.nopid when running office, to
 106                        get timestamps written out.
 107        PARALLELISM     If not empty, pass argument on as the -j switch
 108                        to recursive make invocations. Useful to
 109                        lower/increase build parallelism individually.
 110        LEXFLAGS        Add as flags for LEX scanner generator invocation.
 111        YACCFLAGS       Add as flags for YACC parser generator invocation.
 112        CPPFLAGS        Add as preprocessor flags for C/C++/ObjC/ObjC++ compilation.
 113        CFLAGS          Add as compiler flags for plain C compilation.
 114        CXXFLAGS        Add as compiler flags for C++ compilation.
 115        OBJCFLAGS       Add as compiler flags for Objective C compilation.
 116        OBJCXXFLAGS     Add as compiler flags for Objective C++ compilation.
 117        LDFLAGS         Add as linker flags.
 118        gb_FULLDEPS     Generate and use dependencies (on by default, handle with care).
 119        gb_COLOR        Use ASCII color output.
 120        gb_TITLES       Show progress in terminal title.
 121        gb_Side         Either "host" of "build" (default to "host").
 122                        determine if config_host.mk or config_build.mk is used to
 123                        set the build environment.