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