| 1 | ## Tools
|
|---|
| 2 |
|
|---|
| 3 | This directory contains various scripts.
|
|---|
| 4 | Some of them are used by the build system itself and are not relevant for most
|
|---|
| 5 | people. Others are available for manual use, and that category further
|
|---|
| 6 | divides into those meant to be used in the source directory, and those that
|
|---|
| 7 | work on the build directory.
|
|---|
| 8 |
|
|---|
| 9 |
|
|---|
| 10 | ### Source directory scripts
|
|---|
| 11 |
|
|---|
| 12 | * build_all.sh
|
|---|
| 13 | - Builds (or incrementally rebuilds) all predefined HelenOS configurations.
|
|---|
| 14 | Can be executed in arbitrary directory outside the source tree.
|
|---|
| 15 | * build-ccheck.sh
|
|---|
| 16 | - Builds the ccheck tool.
|
|---|
| 17 | * ccheck.sh
|
|---|
| 18 | - Runs the ccheck tool to verify coding style of C files in the repository.
|
|---|
| 19 | * dest_build.py
|
|---|
| 20 | - Legacy tool for out-of-tree build of the old Makefile-based source tree. Obsoleted by Meson.
|
|---|
| 21 | * srepl
|
|---|
| 22 | - A refactoring tool for global search-and-replace operations. Sed wrapper.
|
|---|
| 23 | * toolchain.sh
|
|---|
| 24 | - Builds the cross-compiler toolchains necessary to build HelenOS.
|
|---|
| 25 | * release.sh
|
|---|
| 26 | - Builds everything (as in build_all.sh), and generates release artifacts.
|
|---|
| 27 |
|
|---|
| 28 |
|
|---|
| 29 | ### Build directory scripts
|
|---|
| 30 |
|
|---|
| 31 | * ew.py
|
|---|
| 32 | - Emulator Wrapper. After building the system image, some machines can be
|
|---|
| 33 | run in an emulator, mostly QEMU. This script simplifies it.
|
|---|
| 34 | * export.sh
|
|---|
| 35 | - Exports a subset of development files in a form suitable for cross-compiling
|
|---|
| 36 | third-party software independently of the HelenOS source tree.
|
|---|
| 37 | The exported files are specific for the currently built configuration.
|
|---|
| 38 |
|
|---|
| 39 |
|
|---|
| 40 | ### Used by build scripts
|
|---|
| 41 |
|
|---|
| 42 | * autocheck.awk
|
|---|
| 43 | * cc.sh
|
|---|
| 44 | * config.py
|
|---|
| 45 | * mkarray.py, mkarray_for_meson.sh
|
|---|
| 46 | * mkuimage.py
|
|---|
| 47 |
|
|---|
| 48 |
|
|---|
| 49 | ### Misc
|
|---|
| 50 |
|
|---|
| 51 | * filldir.py
|
|---|
| 52 | - Fill a directory with N empty directories. Seems to be unused, purpose unclear.
|
|---|
| 53 | * gentestfile.py
|
|---|
| 54 | - Generates test file for uspace/app/testread.
|
|---|
| 55 | * jobfile.py
|
|---|
| 56 | - Obsolete tooling support. Replaced by Meson.
|
|---|
| 57 | * mkext2.py, mkext4.py, mkfat.py
|
|---|
| 58 | - File system builders that don't require root privileges.
|
|---|
| 59 | Used by build scripts and by ew.py.
|
|---|
| 60 | * travis.sh
|
|---|
| 61 | - Runs Travis CI jobs. Not meant for human consumption.
|
|---|
| 62 | * imgutil.py, xstruct.py, xtui.py
|
|---|
| 63 | - Libraries for other python scripts.
|
|---|
