-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
refactor: add make help
to display the usage for project Makefile
#2107
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you very much, this is super helpful. Also I think it's a great trick to semi-automate the help overview, do you mind if I use this for another project as well?
Glad to see you like this😀 And all suggestion changes have been addressed~ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tACK, LGTM 🎉
@Halimao can you please squash the two commits into a single one? Thanks.
Pull Request Test Coverage Report for Build 7598453773Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
c417a2f
to
b5c699a
Compare
Done~ |
This commit adds a description to each make goal that is printed when `make help` is run. Idea borrowed from btcsuite/btcd#2107.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM ⛵
Thanks for the squash. But the commit message now is pretty non-descriptive. Can you update that to at least contain some context of what the commit changes? Then we can merge, thanks. |
b5c699a
to
2a55ff4
Compare
Addressed~ |
Description
This pr added a new
make help
function for displaying which commonly used commands that the Makefile supported. This is useful when a new developer goes to find a helpful tool for testing or building etc.