blob: 8c1b7e0df46ded98273400afb708708f90fa3d95 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
# Local Tools
The scripts in this directory assume they will be run from the root of the
project, as `tools/NAME`. They contain brief, branch-free, composable scripts
intended to be run to achieve frequent goals. They act as a shared shell
history, of a sorts, and as a place to put command-line-ish code that needs to
be shared by multiple components.
Each script begins with a brief comment demonstrating the intended invocation
and the effects.
## Authoring
Tools _should_ begin with a shebang or shell `set` expression that enables
exiting on failure and that enables command echoing, followed by a documentation
comment:
```bash
#!/bin/bash -ex
# tools/my-example-tool
#
# Runs all example tasks.
: …
```
|
