Skip to content

meta(make): Add help messages to Makefile#1419

Merged
olksdr merged 5 commits intomasterfrom
feat/add-help-into-make
Aug 16, 2022
Merged

meta(make): Add help messages to Makefile#1419
olksdr merged 5 commits intomasterfrom
feat/add-help-into-make

Conversation

@olksdr
Copy link
Copy Markdown
Contributor

@olksdr olksdr commented Aug 16, 2022

Adding useful documentation or help messages to the Makefile will help
contributors to quickly check all the available targets and what exactly
they do without opening the file itself.

Now one can just run make help to get the beautiful help message, like :

❯ make help
Usage: make <target>
Targets:
  all                   run all checks and tests
  check                 run the lints and check the code style for rust and python code
  clean                 remove python virtual environment and delete cached rust files together with .target folder
  build                 build relay with all features enabled with debug info
  release               build production release of the relay with

...

#skip-changelog

olksdr and others added 5 commits August 15, 2022 08:25
Adding useful documentation or help messages to the Makefile will help
contributers to quickly check all the available targets and what exactly
they do without opening the file itself.
Co-authored-by: Jan Michael Auer <account@jauer.org>
Co-authored-by: Iker Barriocanal <32816711+iker-barriocanal@users.noreply.github.com>
@olksdr olksdr requested a review from a team August 16, 2022 14:59
@olksdr olksdr self-assigned this Aug 16, 2022
@olksdr olksdr merged commit 54cf70c into master Aug 16, 2022
@olksdr olksdr deleted the feat/add-help-into-make branch August 16, 2022 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants