6.1.2.12. MakeIntegration

Use Make for analysis compilation

This rule calls Make with the specified build and clean targets.

Use this rule to call make with appropriate parameters to generate the desired IR file (most likely /Project/ir).

Options

The following places define options that affect this rule: BuildSystemIntegration, Project-GlobalOptions

abort_on_error

abort_on_error : bool = True

If set to true and the build step returns a non-zero exit-code, the build is aborted. Otherwise a non-zero exit-code is logged but the build continues.
 

build_target

build_target : str | None = 'all'

The target name(s) for building the project. If this is unset the build step will not be run. If this is set to the empty string, Make without a target will be called.
 

capture_output

capture_output : bool = False

Sets whether the shell output of the step should be captured. Note that only the output of the build step will be captured and not the output of possible clean steps.

The output will be parsed according to the format configured with the options output_format, stdout_format, stderr_format.

 

clean_target

clean_target : str | None = 'clean'

The target name(s) for cleaning the project. If this is unset the clean step will not be run. If this is set to the empty string, Make without a target will be called. Note: calling Make without a target for cleaning might not be what you want!
 

cwd

cwd : bauhaus.analysis.config.ProjectRelativePath | None = None

Directory where to call Make. Defaults to /Project/directory if left unspecified.
 

environment

environment

Type: dict[str, str]

Default:

{
   'COMPILE_ONLYIR': '1'
}

Environment for extending the call of Make. These entries are added to the environment and existing ones will be overwritten.

By default, COMPILE_ONLYIR=1 results in the injected irWRAPPERS only creating IR files (with their original filenames) but no native object files. If your build also requires the native objects and executables in addition to the IR files, remove COMPILE_ONLYIR from the environment to get the native files with original names and the IR files with .ir appended.

 

makefile

makefile : bauhaus.analysis.config.ProjectRelativePath | None = None

The Makefile to use.
 

options

options : str | None = None

Additional command-line parameters for Make. Any Make variable listed here takes precedence over the same Make variable listed in variables.
 

output_format

output_format : list[str] = ['generic']

Name of the format(s) describing the output pattern to capture from stdout/stderr.

The format names available here correspond to the provider options in /Analysis/AnalysisControl/ExternalAnalysisFormats.

This option only has an effect if capture_output is true.

 

stderr_format

stderr_format : list[str] = []

Name of the format(s) describing the output pattern to capture from stderr. This takes precedence over output_format if set.

The format names available here correspond to the provider options in /Analysis/AnalysisControl/ExternalAnalysisFormats.

This option only has an effect if capture_output is true.

 

stdout_format

stdout_format : list[str] = []

Name of the format(s) describing the output pattern to capture from stdout. This takes precedence over output_format if set.

The format names available here correspond to the provider options in /Analysis/AnalysisControl/ExternalAnalysisFormats.

This option only has an effect if capture_output is true.

 

toolname

toolname : str = 'make'

Make command-line tool to call.
 

variables

variables

Type: dict[str, str]

Default:

{
   'AR': 'irAR',
   'CC': 'irCC',
   'CXX': 'irCXX',
   'LD': 'irCXX'
}

Set of Make variables to override when invoking the build. Typically you want to replace variables like CC, CXX, LD, AR and perhaps others with the Axivion compiler toolchain tools.

If variables listed here are also in the options, then the ones in options take precedence.

We provide the following tool wrappers (irWRAPPERS):

Wrapper nameMake variableSynopsis of wrapped tool
irAR AR Archiver
irCC CC/LD C Compiler
irCP CP File copy tool
irCXX CXX/LD C++ compiler
irLD LD Linker
irLIBTOOL GNU Portable Library Tool
irLN LN File symlink tool
irLTORANLIB gcc-ranlib tool
irMT Microsoft Manifest Tool
irMV MV File move tool
irNVCC NVCC Nvidia CUDA compiler
irOBJCOPY OBJCOPY Object copy tool
irOBJDUMP OBJDUMP Object dump tool
irRANLIB RANLIB ranlib tool
irSIZE SIZE Size tool
irSTRIP STRIP Strip tool
Those wrappers behave differently, depending on whether and how the environment variables COMPILE_ONLY or COMPILE_ONLYIR are set.

For details, please see explanation of irWRAPPERS in the documentation.