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 64 65 66 67 68 69 70 71 72 73 74 75
|
<!--
@license Apache-2.0
Copyright (c) 2021 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# Utilities
> Utility commands for use in [`make`][make] recipes.
<!-- 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 providing various utilities for use in [`make`][make] recipes.
</section>
<!-- /.intro -->
<!-- Usage documentation. -->
<section class="usage">
## Usage
```text
Usage: make <command> [<ENV_VAR>=<value> <ENV_VAR>=<value> ...]
```
### Commands
#### assert-clean-working-directory
Asserts that the current working directory is "clean" (i.e., does not contain any uncommitted changes)
```bash
$ make assert-clean-working-directory
```
</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 -->
|