tools::build_api Namespace Reference

Add a single result to a report dictionary

Positional arguments:
report - the report to append to
result - the result to append

Legacy method for building mbed libraries

Positional arguments:
lib_id - the library's unique identifier
target - the MCU or board that the project will compile for
toolchain_name - the name of the build tools

Keyword arguments:
clean - Rebuild everything if True
verbose - Write the actual tools command lines used if True
macros - additional macros
notify - Notify function for logs
jobs - how many compilers we can run at once
silent - suppress printing of progress indicators
report - a dict where a result may be appended
properties - UUUUHHHHH beats me
extra_verbose - even more output!
build_profile - a dict of flags that will be passed to the compiler

Build a library

Positional arguments:
src_paths - a path or list of paths that contain all files needed to build
            the library
build_path - the directory where all of the object files will be placed
target - the MCU or board that the project will compile for
toolchain_name - the name of the build tools

Keyword arguments:
dependencies_paths - The location of libraries to include when linking
name - the name of the library
clean - Rebuild everything if True
archive - whether the library will create an archive file
notify - Notify function for logs
verbose - Write the actual tools command lines used if True
macros - additional macros
inc_dirs - additional directories where include files may be found
jobs - how many compilers we can run at once
silent - suppress printing of progress indicators
report - a dict where a result may be appended
properties - UUUUHHHHH beats me
extra_verbose - even more output!
project_id - the name that goes in the report
remove_config_header_file - delete config header file when done building
app_config - location of a chosen mbed_app.json file
build_profile - a dict of flags that will be passed to the compiler

Function returns True is library was built and false if building was
skipped

Positional arguments:
target - the MCU or board that the project will compile for
toolchain_name - the name of the build tools

Keyword arguments:
verbose - Write the actual tools command lines used if True
clean - Rebuild everything if True
macros - additional macros
notify - Notify function for logs
jobs - how many compilers we can run at once
silent - suppress printing of progress indicators
report - a dict where a result may be appended
properties - UUUUHHHHH beats me
extra_verbose - even more output!
build_profile - a dict of flags that will be passed to the compiler

Build a project. A project may be a test or a user program.

Positional arguments:
src_paths - a path or list of paths that contain all files needed to build
            the project
build_path - the directory where all of the object files will be placed
target - the MCU or board that the project will compile for
toolchain_name - the name of the build tools

Keyword arguments:
libraries_paths - The location of libraries to include when linking
linker_script - the file that drives the linker to do it's job
clean - Rebuild everything if True
notify - Notify function for logs
verbose - Write the actual tools command lines used if True
name - the name of the project
macros - additional macros
inc_dirs - additional directories where include files may be found
jobs - how many compilers we can run at once
silent - suppress printing of progress indicators
report - a dict where a result may be appended
properties - UUUUHHHHH beats me
project_id - the name put in the report
project_description - the human-readable version of what this thing does
extra_verbose - even more output!
config - a Config object to use instead of creating one
app_config - location of a chosen mbed_app.json file
build_profile - a dict of flags that will be passed to the compiler
stats_depth - depth level for memap to display file/dirs

Create a result dictionary

Positional arguments:
target_name - the target being built for
toolchain_name - the toolchain doing the building
id_name - the name of the executable or library being built
description - a human readable description of what's going on

Get the configuration object for a target-toolchain combination

Positional arguments:
src_paths - paths to scan for the configuration files
target - the device we are building for
toolchain_name - the string that identifies the build tools

Given a release version string, return a tuple that contains a target
and the supported toolchains for that release.
Ex. Given '2', return (('LPC1768', ('ARM', 'GCC_ARM')),
                       ('K64F', ('ARM', 'GCC_ARM')), ...)

Positional arguments:
version - The version string. Should be a string contained within
          RELEASE_VERSIONS

Returns target supported toolchains list

Positional arguments:
target - the target to get the supported toolchains of

Get list of all unique toolchains supported by targets

Keyword arguments:
release_targets - tuple structure returned from get_mbed_official_release().
                  If release_targets is not specified, then it queries all
                  known targets

Returns True, None if a target is part of the official release for the
given version. Return False, 'reason' if a target is not part of the
official release for the given version.

Positional arguments:
target_name - Name if the target (ex. 'K64F')
version - The release version string. Should be a string contained within
          RELEASE_VERSIONS

Shows target list

Shows list of toolchains

Shows target map using prettytable

Keyword arguments:
verbose_html - emit html instead of a simple table
platform_filter - remove results that match the string
release_version - get the matrix for this major version number

Merge the region_list into a single image

Positional Arguments:
region_list - list of regions, which should contain filenames
destination - file name to write all regions to
padding - bytes to fill gapps with

Setup test properties

Positional arguments:
properties - the dict to fill
target_name - the target the test is targeting
toolchain_name - the toolchain that will compile the test
vendor_label - the vendor

Setup report keys

Positional arguments:
report - the report to fill
target_name - the target being used
toolchain_name - the toolchain being used
id_name - the name of the executable or library being built

Prepares resource related objects - toolchain, target, config

Positional arguments:
src_paths - the paths to source directories
target - ['LPC1768', 'LPC11U24', etc.]
toolchain_name - ['ARM', 'uARM', 'GCC_ARM', 'GCC_CR']

Keyword arguments:
macros - additional macros
clean - Rebuild everything if True
jobs - how many compilers we can run at once
notify - Notify function for logs
silent - suppress printing of progress indicators
verbose - Write the actual tools command lines used if True
extra_verbose - even more output!
config - a Config object to use instead of creating one
app_config - location of a chosen mbed_app.json file
build_profile - a list of mergeable build profiles

Generate result table with memory usage values for build results
Aggregates (puts together) reports obtained from self.get_memory_summary()

Positional arguments:
report - Report generated during build procedure.

Generate result string for build results

Positional arguments:
result_list - the list of results to print
build_name - the name of the build we are printing result for

Scan resources using initialized toolcain

Positional arguments
src_paths - the paths to source directories
toolchain - valid toolchain object
dependencies_paths - dependency paths that we should scan for include dirs
inc_dirs - additional include directories which should be added to
           the scanner resources

Given a list of toolchains and a release version, return a list of
only the supported toolchains for that release

Positional arguments:
toolchains - The list of toolchains
version - The release version string. Should be a string contained within
          RELEASE_VERSIONS

Write a build report to disk using a template file

Positional arguments:
build_report - a report generated by the build system
template_filename - a file that contains the template for the style of build
                    report
filename - the location on disk to write the file to