README.md
1<!--
2 Copyright 2020, Data61, CSIRO (ABN 41 687 119 230)
3
4 SPDX-License-Identifier: BSD-2-Clause
5-->
6
7# seL4_tools misc tools
8
9These are a collection of tools or configuration files that relate to seL4 in some way.
10
11## Style tools
12
13Many of the files are for use in styling sources for various languages.
14
15Files for styling a particular language:
16- `style-c.sh`, `astylerc`: Style a single c file using `astyle` and the astylerc config
17- `style-cmake.sh`: Style a CMake file using `cmake-format`. Will also look for `.cmake-format.yaml`
18 files in repo directories.
19- `style-py.sh`: Style python files using `autopep8`
20- `.gitlint`: Configuration file for `gitlint` tool for checking Git commit messages.
21- `is-valid-shell-script`: Script for checking valid shell script syntax.
22
23Scripts for batching multiple style operations across different files:
24- `style.sh`: Finds any `.stylefilter` files in local directories and calls `style.py`
25- `style.py`, `filter.py`: Filters an input list of files based on `.stylefilter` and then calls the relevant
26 style script based on the remaining file's extensions.
27- `style-changed.sh`: Styles all changed files in current Git repository
28- `style-all.sh`: Styles all files in current Git repository
29
30## Other
31
32- `whence.py`: A tool for determining source code provenance for imported repositories without history.
33- `cpio-strip.c`/`Makefile.cpio_strip`: A program for stripping metadata from CPIO archives to enable
34 reproducible builds. (Recent versions of cpio support this with the `--reproducible` flag)
35- `cobbler`: Build a qemu-bootable harddisk image.
36