Skip to content

Commit dc1198b

Browse files
authored
Merge pull request #10254 from theotherjimmy/remove-some-deadcode
Remove unused tools modules and document the used ones.
2 parents 65ada92 + 2a4a73c commit dc1198b

31 files changed

+60
-3794
lines changed

tools/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Mbed OS Build Tools
2+
3+
This directory contains the python tools used for building Mbed OS and
4+
Mbed 2.
5+
6+
Quick navigation:
7+
8+
| file/directory | Purpose/function |
9+
|-----------------------|------------------------------------------------|
10+
| `build.py` | implementation of `mbed compile --library` |
11+
| `build_api.py` | full-project build operations |
12+
| `build_release.py` | CLI for making an mbed 2 release |
13+
| `config` | implementation of Config System |
14+
| `debug_tools` | Crash log parsing |
15+
| `default_settings.py` | Default version of project local `settings.py` |
16+
| `detect_targets.py` | implementation of `mbed detect` |
17+
| `device_management.py`| implementation of `mbed device-management` |
18+
| `export` | Export plugins and API for woking with them |
19+
| `flash_algo` | CMSIS flash algorithm parser |
20+
| `get_config.py` | implementation of `mbed compile --config` |
21+
| `host_tests` | location of pre-htrun host tests |
22+
| `importer` | code importer for use with CMSIS, TFM/PSA etc. |
23+
| `libraries.py` | constants for building mbed 2 libraries |
24+
| `make.py` | implementation of `mbed compile` |
25+
| `memap.py` | map file parser and sumary generator |
26+
| `notifier` | API for seting compile status to a frontend |
27+
| `options.py` | Default option parser and option utilities |
28+
| `paths.py` | constants for many paths used |
29+
| `profiles` | location of the default build profiles |
30+
| `project.py` | implementation of `mbed export` |
31+
| `psa` | PSA |
32+
| `regions.py` | merging from managed bootloader mode |
33+
| `resources` | scans directories for files used in a project |
34+
| `run_icetea.py` | implementation of `mbed test --icetea` |
35+
| `settings.py` | project specific settings from env vars |
36+
| `singletest.py` | location of pre-greentea greentea |
37+
| `targets` | target description reader and post-build steps |
38+
| `test` | unit tests for tools |
39+
| `test_api.py` | part of pre-greentea greentea |
40+
| `test_configs` | configuration files used by `mbed test` |
41+
| `test_exporters.py` | part of pre-greentea greentea |
42+
| `tests.py` | implementation of `mbed test --greentea` |
43+
| `toolchains` | API for calling the selected compiler |
44+
| `utils.py` | General purpose utilities like file moving |
45+

tools/build_travis.py

Lines changed: 0 additions & 408 deletions
This file was deleted.

tools/check_release.json

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)