summaryrefslogtreecommitdiff
path: root/solenv/gbuild/gbuild.help.txt
blob: 93649942e573c1c52fc353c33429182ed85d8544 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
NAME
       gbuild - GNU make based build system for LibreOffice

SYNOPSIS
       make [ -f makefile ] [ options ] [ variable=value ... ] [ targets ] ...

IMPORTANT OPTIONS
       -s Silent operation; do not print the commands as they are executed.

       -n Print the commands that would be executed, but do not execute them.
       -k Continue as much as possible after an error.

       -j Specifies the number of jobs (commands) to run simultaneously.
       -l Specifies that no new jobs (commands) should be started if there are
          others jobs running and the load average is at least load.

       -t Touch files (mark them up to date without really changing them)
          instead of running their commands.
       -W Pretend that the target file has just been modified.
       -o Do not remake the file file even if it is older than its
          dependencies, and do not remake anything on account of changes in file.

       -p Print the data base (rules and variable values) that results from
          reading the makefiles.
       --debug=b debug make run, see GNU make man page for details

       (descriptions from GNU make man page)

AVAILABLE TARGETS
       all              build product and run unit tests (default goal)
       build            build product
       unitcheck        run unit tests
       slowcheck        run slow unit tests
       subsequentcheck  run system tests (requires full installation)
       stagingcheck     run (unstable/failing) tests from staging area
                        (requires full installation)
       perfcheck        run performance/callgrind unit tests
       check            run unit tests and if in toplevel subsequentcheck
       clean            remove all generated files
       debugrun         starts the INSTDIR instance and allows tests to be run
                        against it
       dump-deps-png    creates dependency diagrams in PNG format
                        NOTE: needs graphviz to work
       showmodules      shows all registered modules
       <module>         build the named module
       <module>.check   run unittests of the named module
       <module>.clean   clean the named module
       <module>.all     build the named module and the pre-requisite modules for it
       <module>.showdeliverables show the targets delivered to INSTDIR and their
                        source
       cmd              execute the command contained in the variable cmd=""
                        in a shell with config_host.mk or config_build.mk
                        environment set. (see gb_SIDE)
       <target>         build gbuild target (such as Library_vbaswobj or
                        CppunitTest_sw_macros_test)
       <target>.clean   clean gbuild target
       <class>_<target> for all targets and for the following classes:
           o AllLangResTarget
           o AllLangZip
           o CliLibrary
           o CliNativeLibrary
           o CliUnoApi
           o Configuration
           o CppunitTest
           o CustomTarget
           o Dictionary
           o Executable
           o Extension
           o ExternalPackage
           o ExternalProject
           o Gallery
           o Helper
           o InstallModule
           o InstallScript
           o InternalUnoApi
           o Jar
           o JunitTest
           o Library
           o Package
           o Pagein
           o PythonTest_pytests
           o Pyuno
           o Rdb
           o StaticLibrary
           o UI
           o UnoApi
           o UnpackedTarball
           o WinResTarget
           o Zip

INTERACTIVE VARIABLES:
       DEBUG / debug   If not empty, build as with --enable-debug.
       ENABLE_SYMBOLS / enable_symbols
                       If not empty, build as with --enable-symbols.
       DBGLEVEL / dbglevel
                       If not empty, force the debug level to the specified value. The
                       debug level is passed to the source code through OSL_DEBUG_LEVEL
                       macro.
                       0 = no debug (as with --disable-debug)
                       1 = debugging information + no optimizations (as with --enable-debug)
                       (Note that levels higher than 2 are used only by obsolete debugging
                       features. Use SAL_INFO/SAL_WARN with a specific area for extra debug
                       output in new code.)
                       2 = debugging information + no optimizations + extra
                           debug output. OSL_TRACE starts being active on this
                           level.
                       3... = debugging information + no optimizations + extra
                              debug output (usually extremely verbose). Levels
                              > 2 are not used very much.
       PARALLELISM     If not empty, pass argument on as the -j switch
                       to recursive make invocations. Useful to
                       lower/increase build parallelism individually.
       LEXFLAGS        Append flags for LEX scanner generator invocation.
       YACCFLAGS       Append flags for YACC parser generator invocation.
       CPPFLAGS        Append preprocessor flags for C/C++/ObjC/ObjC++ compilation.
       CFLAGS          Override compiler flags for plain C compilation.
       ENVCFLAGS       Append compiler flags for plain C compilation.
       CXXFLAGS        Override compiler flags for C++ compilation.
                       Note: this overrides default optimization and debug
                       flags; to append flags without overriding, use:
                       CXXFLAGS='$(call gb_LinkTarget__get_debugcxxflags,$(1)) -Wfoo'
       ENVCFLAGSCXX    Append compiler flags for C++ compilation.
       OBJCFLAGS       Override compiler flags for Objective C compilation.
       OBJCXXFLAGS     Override compiler flags for Objective C++ compilation.
       LDFLAGS         Override linker flags.
       gb_FULLDEPS     Generate and use dependencies (on by default, handle with care).
       gb_COLOR        Use ASCII color output.
       gb_TITLES       Show progress in terminal title.
       gb_Side         Either "host" or "build" (default to "host").
                       determine if config_host.mk or config_build.mk is used to
                       set the build environment.