diff options
| author | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-11-30 11:45:31 +0300 |
|---|---|---|
| committer | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-11-30 11:45:31 +0300 |
| commit | 7b9ec616165c0b6c026dd1d5e156d1ac37c2a65d (patch) | |
| tree | 95a176b874a088911d655e6bd464d24b258d8ce9 /doc | |
| parent | b06620945c2c8872897d332345581639fcdc0d18 (diff) | |
doc: Document `make help` target in the beginners guide
While we already have some advice in our beginners guide about how to
use our Makefile, it doesn't hint at the available `make help` target.
Mention it so that users can discover by themselves what other targets
exist.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/beginners_guide.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/beginners_guide.md b/doc/beginners_guide.md index 502df1052..6635435a8 100644 --- a/doc/beginners_guide.md +++ b/doc/beginners_guide.md @@ -56,6 +56,8 @@ frequently used targets: - `clean`: Remove all generated build artifacts. +- `help`: Print a list of available Makefile targets and variables. + You can modify some parts of the build process by setting up various variables. For example, by executing `make V=1` you can do a verbose build or by overriding the `PROTOC_VERSION` and `PROTOC_HASH` a different protobuf compiler version |