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        showdeliverables show the targets delivered to OUTDIR and their source
  38        showmodules      show the modules that would be loaded
  39        debugrun         starts the dev-install instance and allows tests to be run
  40                         against it
  41        <module>         build the named module
  42        <module>.check   run unittests of the named module
  43        <module>.clean   clean the named module
  44        <module>.all     build the named module and the pre-requisite modules for it
  45        <module>.deliver for dmake modules only, deliver the named module
  46        cmd              execute the command contained in the variable cmd=""
  47                         in a shell with config_host.mk or config_build.mk
  48                         environement set. (see gb_SIDE)
  49
  50 INTERACTIVE VARIABLES:
  51        DEBUG / debug   If not empty, build as with --enable-debug.
  52        ENABLE_SYMBOLS / enable_symbols
  53                        If not empty, build as with --enable-symbols.
  54        DBGLEVEL / dbglevel
  55                        If not empty, force the debug level to the specified value. The
  56                        debug level is passed to the source code through OSL_DEBUG_LEVEL
  57                        macro.
  58                        0 = no debug (as with --disable-debug)
  59                        1 = debugging information + no optimizations (as with --enable-debug)
  60                        (Note that levels higher than 2 are used only by obsolete debugging
  61                        features. Use SAL_INFO/SAL_WARN with a specific area for extra debug
  62                        output in new code.)
  63                        2 = degugging information + no optimizations + extra
  64                            debug output. OSL_TRACE starts being active on this
  65                            level.
  66                        3... = degugging information + no optimizations + extra
  67                               debug output (usually extremely verbose). Levels
  68                               > 2 are not used very much.
  69
  70        TIMELOG / timelog
  71                        If not empty enable the RTL_LOGFILE_* time logging facility.
  72                        export RTL_LOGFILE=rtl_logfile.nopid when running office, to
  73                        get timestamps written out.
  74        PARALLELISM     If not empty, pass argument on as the -j switch
  75                        to recursive make invocations. Useful to
  76                        lower/increase build parallelism individually.
  77        LEXFLAGS        Add as flags for LEX scanner generator invocation.
  78        YACCFLAGS       Add as flags for YACC parser generator invocation.
  79        CPPFLAGS        Add as preprocessor flags for C/C++/ObjC/ObjC++ compilation.
  80        CFLAGS          Add as compiler flags for plain C compilation.
  81        CXXFLAGS        Add as compiler flags for C++ compilation.
  82        OBJCFLAGS       Add as compiler flags for Objective C compilation.
  83        OBJCXXFLAGS     Add as compiler flags for Objective C++ compilation.
  84        LDFLAGS         Add as linker flags.
  85        gb_FULLDEPS     Generate and use dependencies (on by default, handle with care).
  86        gb_COLOR        Use ASCII color output.
  87        gb_TITLES       Show progress in terminal title.
  88        gb_Side         Either "host" of "build" (default to "host").
  89                        determine if config_host.mk or config_build.mk is used to
  90                        set the build environment.