Skip to content

Remove unused tools modules and document the used ones. #10254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Apr 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions tools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Mbed OS Build Tools
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😲


This directory contains the python tools used for building Mbed OS and
Mbed 2.

Quick navigation:

| file/directory | Purpose/function |
|-----------------------|------------------------------------------------|
| `build.py` | implementation of `mbed compile --library` |
| `build_api.py` | full-project build operations |
| `build_release.py` | CLI for making an mbed 2 release |
| `config` | implementation of Config System |
| `debug_tools` | Crash log parsing |
| `default_settings.py` | Default version of project local `settings.py` |
| `detect_targets.py` | implementation of `mbed detect` |
| `device_management.py`| implementation of `mbed device-management` |
| `export` | Export plugins and API for woking with them |
| `flash_algo` | CMSIS flash algorithm parser |
| `get_config.py` | implementation of `mbed compile --config` |
| `host_tests` | location of pre-htrun host tests |
| `importer` | code importer for use with CMSIS, TFM/PSA etc. |
| `libraries.py` | constants for building mbed 2 libraries |
| `make.py` | implementation of `mbed compile` |
| `memap.py` | map file parser and sumary generator |
| `notifier` | API for seting compile status to a frontend |
| `options.py` | Default option parser and option utilities |
| `paths.py` | constants for many paths used |
| `profiles` | location of the default build profiles |
| `project.py` | implementation of `mbed export` |
| `psa` | PSA |
| `regions.py` | merging from managed bootloader mode |
| `resources` | scans directories for files used in a project |
| `run_icetea.py` | implementation of `mbed test --icetea` |
| `settings.py` | project specific settings from env vars |
| `singletest.py` | location of pre-greentea greentea |
| `targets` | target description reader and post-build steps |
| `test` | unit tests for tools |
| `test_api.py` | part of pre-greentea greentea |
| `test_configs` | configuration files used by `mbed test` |
| `test_exporters.py` | part of pre-greentea greentea |
| `tests.py` | implementation of `mbed test --greentea` |
| `toolchains` | API for calling the selected compiler |
| `utils.py` | General purpose utilities like file moving |

408 changes: 0 additions & 408 deletions tools/build_travis.py

This file was deleted.

18 changes: 0 additions & 18 deletions tools/check_release.json

This file was deleted.

Loading