Brian Daniels / mbed-tools

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-tools by Morpheus

Embed: (wiki syntax)

« Back to documentation index

sources::build_api Namespace Reference
Functions

sources::build_api Namespace Reference

Functions

def build_project
def build_library
def build_lib
def build_mbed_libs
def get_unique_supported_toolchains
def mcu_toolchain_matrix
def get_target_supported_toolchains
def static_analysis_scan_library
def print_build_results

Detailed Description

mbed SDK
Copyright (c) 2011-2013 ARM Limited

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Function Documentation

def sources::build_api::build_lib (   lib_id,
  target,
  toolchain,
  options = None,
  verbose = False,
  clean = False,
  macros = None,
  notify = None,
  jobs = 1,
  silent = False,
  report = None,
  properties = None,
  extra_verbose = False 
) 
Wrapper for build_library function.
    Function builds library in proper directory using all dependencies and macros defined by user.

Definition at line 303 of file build_api.py.

def sources::build_api::build_library (   src_paths,
  build_path,
  target,
  toolchain_name,
  dependencies_paths = None,
  options = None,
  name = None,
  clean = False,
  notify = None,
  verbose = False,
  macros = None,
  inc_dirs = None,
  inc_dirs_ext = None,
  jobs = 1,
  silent = False,
  report = None,
  properties = None,
  extra_verbose = False 
) 
src_path: the path of the source directory
build_path: the path of the build directory
target: ['LPC1768', 'LPC11U24', 'LPC2368']
toolchain: ['ARM', 'uARM', 'GCC_ARM', 'GCC_CR']
library_paths: List of paths to additional libraries
clean: Rebuild everything if True
notify: Notify function for logs
verbose: Write the actual tools command lines if True
inc_dirs: additional include directories which should be included in build
inc_dirs_ext: additional include directories which should be copied to library directory

Definition at line 185 of file build_api.py.

def sources::build_api::build_mbed_libs (   target,
  toolchain_name,
  options = None,
  verbose = False,
  clean = False,
  macros = None,
  notify = None,
  jobs = 1,
  silent = False,
  report = None,
  properties = None,
  extra_verbose = False 
) 
Function returns True is library was built and false if building was skipped

Definition at line 332 of file build_api.py.

def sources::build_api::build_project (   src_path,
  build_path,
  target,
  toolchain_name,
  libraries_paths = None,
  options = None,
  linker_script = None,
  clean = False,
  notify = None,
  verbose = False,
  name = None,
  macros = None,
  inc_dirs = None,
  jobs = 1,
  silent = False,
  report = None,
  properties = None,
  project_id = None,
  project_description = None,
  extra_verbose = False 
) 
This function builds project. Project can be for example one test / UT

Definition at line 78 of file build_api.py.

def sources::build_api::get_target_supported_toolchains (   target ) 
Returns target supported toolchains list

Definition at line 507 of file build_api.py.

def sources::build_api::get_unique_supported_toolchains (  ) 
Get list of all unique toolchains supported by targets

Definition at line 452 of file build_api.py.

def sources::build_api::mcu_toolchain_matrix (   verbose_html = False,
  platform_filter = None 
) 
Shows target map using prettytable

Definition at line 462 of file build_api.py.

def sources::build_api::print_build_results (   result_list,
  build_name 
) 
Generate result string for build results

Definition at line 712 of file build_api.py.

def sources::build_api::static_analysis_scan_library (   src_paths,
  build_path,
  target,
  toolchain_name,
  cppcheck_cmd,
  cppcheck_msg_format,
  dependencies_paths = None,
  options = None,
  name = None,
  clean = False,
  notify = None,
  verbose = False,
  macros = None,
  jobs = 1,
  extra_verbose = False 
) 
Function scans library (or just some set of sources/headers) for staticly detectable defects

Definition at line 635 of file build_api.py.

Generated on Thu Jun 15 2023 14:55:00 by  doxygen 1.7.2