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 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
|
# Notes
> Notes commands.
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
<section class="intro">
This directory contains [`make`][make] rules for enumerating file annotations, such as todos, warnings, and fixmes.
</section>
<!-- /.intro -->
<!-- Usage documentation. -->
<section class="usage">
## Usage
```text
Usage: make <command> [<ENV_VAR>=<value> <ENV_VAR>=<value> ...]
```
### Commands
#### notes
Searches for annotated comments.
<!-- run-disable -->
```bash
$ make notes
```
The command supports the following environment variables:
- **KEYWORDS**: pipe-delimited list of keywords identifying annotations; e.g., `TODO|FIXME|WARNING|HACK|NOTE|OPTIMIZE`.
Annotated comments will be output along with their associated filename and line number.
</section>
<!-- /.usage -->
<!-- Section to include notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="notes">
</section>
<!-- /.notes -->
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="links">
[make]: https://www.gnu.org/software/make/
</section>
<!-- /.links -->
|