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        build                build product (default goal)
  31        clean                remove all generated files
  32        debugrun             starts the INSTDIR instance and allows tests to
  33                             be run against it. You can provide additional
  34                             arguments to soffice.bin using the gb_DBGARGS
  35                             variable.
  36        check                run unit tests and if in toplevel subsequentcheck
  37        unitcheck            run unit tests
  38        slowcheck            run slow unit tests
  39        screenshot           create all screenshots
  40        subsequentcheck      run system tests (requires full installation)
  41        stagingcheck         run (unstable/failing) tests from staging area
  42                             (requires full installation)
  43        perfcheck            run performance/callgrind unit tests
  44
  45        build-l10n-only      builds translation files for the build products
  46        build-non-l10n-only  builds the product without the localization files
  47        translations         extract .pot files to workdir/pot
  48
  49        packageinfo          generates package information for distros
  50        dump-deps-png        creates dependency diagrams in PNG format
  51                             NOTE: needs graphviz to work
  52        showmodules          shows all registered modules
  53
  54        <module>         build the named module (without running unittests)
  55        <module>.build   an alias for the above
  56        <module>.check   run unittests of the named module
  57        <module>.clean   clean the named module
  58        <module>.all     build the named module and the pre-requisite modules for it
  59        <module>.showdeliverables show the targets delivered to INSTDIR and their
  60                         source
  61        cmd              execute the command contained in the variable cmd=""
  62                         in a shell with config_host.mk or config_build.mk
  63                         environment set. (see gb_SIDE)
  64        <target>         build gbuild target (such as Library_vbaswobj or
  65                         CppunitTest_sw_macros_test)
  66        <target>.clean   clean gbuild target
  67        <class>_<target> for all targets and for the following classes:
  68            o AllLangMoTarget
  69            o AllLangZip
  70            o CliLibrary
  71            o CliNativeLibrary
  72            o CliUnoApi
  73            o Configuration
  74            o CppunitTest
  75            o CustomTarget
  76            o Dictionary
  77            o Executable
  78            o Extension
  79            o ExternalPackage
  80            o ExternalProject
  81            o Gallery
  82            o Helper
  83            o InstallModule
  84            o InstallScript
  85            o InternalUnoApi
  86            o Jar
  87            o JunitTest
  88            o Library
  89            o Package
  90            o Pagein
  91            o PythonTest
  92            o Pyuno
  93            o Rdb
  94            o StaticLibrary
  95            o UI
  96            o UnoApi
  97            o UnpackedTarball
  98            o WinResTarget
  99            o Zip
 100
 101 INTERACTIVE VARIABLES:
 102        BUILDTOOLTRACE  Run all commands that invoke built tools in strace,
 103                        valgrind or a debugger:
 104                        BUILDTOOLTRACE='$(DEVENV) /debugexe' PARALLELISM=1 make
 105        DEBUG / debug   If not empty, build as with --enable-debug.
 106        ENABLE_SYMBOLS / enable_symbols
 107                        If not empty, build as with --enable-symbols.
 108        DBGLEVEL / dbglevel
 109                        If not empty, force the debug level to the specified value. The
 110                        debug level is passed to the source code through OSL_DEBUG_LEVEL
 111                        macro.
 112                        0 = no debug (as with --disable-debug)
 113                        1 = debugging information + no optimizations (as with --enable-debug)
 114                        (Note that levels higher than 2 are used only by obsolete debugging
 115                        features. Use SAL_INFO/SAL_WARN with a specific area for extra debug
 116                        output in new code.)
 117                        2 = debugging information + no optimizations + extra
 118                            debug output. OSL_TRACE starts being active on this
 119                            level.
 120                        3... = debugging information + no optimizations + extra
 121                               debug output (usually extremely verbose). Levels
 122                               > 2 are not used very much.
 123        PARALLELISM     If not empty, pass argument on as the -j switch
 124                        to recursive make invocations. Useful to
 125                        lower/increase build parallelism individually.
 126        verbose=t       Verbose mode: display all commands
 127        LEXFLAGS        Append flags for LEX scanner generator invocation.
 128        YACCFLAGS       Append flags for YACC parser generator invocation.
 129        CPPFLAGS        Append preprocessor flags for C/C++/ObjC/ObjC++ compilation.
 130        CFLAGS          Override compiler flags for plain C compilation.
 131        ENVCFLAGS       Append compiler flags for plain C compilation.
 132        CXXFLAGS        Override compiler flags for C++ compilation.
 133                        Note: this overrides default optimization and debug
 134                        flags; to append flags without overriding, use:
 135                        CXXFLAGS='$(call gb_LinkTarget__get_debugflags,$(1)) -Wfoo'
 136        ENVCFLAGSCXX    Append compiler flags for C++ compilation.
 137        OBJCFLAGS       Override compiler flags for Objective C compilation.
 138        OBJCXXFLAGS     Override compiler flags for Objective C++ compilation.
 139        LDFLAGS         Override linker flags.
 140        gb_FULLDEPS     Generate and use dependencies (on by default, handle with care).
 141        gb_COLOR        Use ASCII color output.
 142        gb_TITLES       Show progress in terminal title.
 143        gb_Side         Either "host" or "build" (default to "host").
 144                        determine if config_host.mk or config_build.mk is used to
 145                        set the build environment.
 146        gb_DBGARGS      Append these arguments to GDBs "set args" command for
 147                        debugrun. Double quotes will be automatically escaped.
 148        gb_SUPPRESS_TESTS Do not run tests (but still build them, when requested
 149                        by the given targets).
 150        GCC_COLORS      Colorize gcc diagnostics output. See
 151                        https://gcc.gnu.org/onlinedocs/gcc/Diagnostic-Message-Formatting-Options.html
 152                        for details & syntax. Or export that setting in your .bash_profile.