Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 5 commits into from

Conversation

olksdr
Copy link
Contributor

@olksdr olksdr commented Aug 15, 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

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.
@olksdr olksdr requested a review from a team August 15, 2022 06:33
@olksdr olksdr self-assigned this Aug 15, 2022
@jan-auer jan-auer changed the title docs(make): Add help messages to Makefile meta(make): Add help messages to Makefile Aug 16, 2022
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Co-authored-by: Jan Michael Auer <[email protected]>
Makefile Outdated Show resolved Hide resolved
@olksdr
Copy link
Contributor Author

olksdr commented Aug 16, 2022

closing in favour of #1419

@olksdr olksdr closed this Aug 16, 2022
@olksdr olksdr deleted the feat/add-help-into-make branch August 16, 2022 14:59
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.

3 participants