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

refactor: add make help to display the usage for project Makefile #2107

Merged
merged 1 commit into from
Jan 24, 2024

Conversation

Halimao
Copy link
Contributor

@Halimao Halimao commented Jan 21, 2024

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.

image

Copy link
Collaborator

@guggero guggero left a 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?

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
@Halimao
Copy link
Contributor Author

Halimao commented Jan 22, 2024

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~

Copy link
Collaborator

@guggero guggero left a 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.

@coveralls
Copy link

coveralls commented Jan 22, 2024

Pull Request Test Coverage Report for Build 7598453773

Warning: 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

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 268 unchanged lines in 3 files lost coverage.
  • Overall coverage increased (+0.1%) to 56.784%

Files with Coverage Reduction New Missed Lines %
wire/msgblock.go 6 96.32%
peer/peer.go 7 74.16%
rpcclient/infrastructure.go 255 40.0%
Totals Coverage Status
Change from base Build 7618951160: 0.1%
Covered Lines: 29207
Relevant Lines: 51435

💛 - Coveralls

@Halimao Halimao force-pushed the refactor/make-help branch from c417a2f to b5c699a Compare January 22, 2024 08:25
@Halimao
Copy link
Contributor Author

Halimao commented Jan 22, 2024

tACK, LGTM 🎉

@Halimao can you please squash the two commits into a single one? Thanks.

Done~

guggero added a commit to guggero/lnd that referenced this pull request Jan 22, 2024
This commit adds a description to each make goal that is printed when
`make help` is run.
Idea borrowed from btcsuite/btcd#2107.
Copy link
Collaborator

@yyforyongyu yyforyongyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ⛵

@guggero
Copy link
Collaborator

guggero commented Jan 23, 2024

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.

@Halimao Halimao force-pushed the refactor/make-help branch from b5c699a to 2a55ff4 Compare January 24, 2024 02:30
@Halimao
Copy link
Contributor Author

Halimao commented Jan 24, 2024

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.

Addressed~

@Roasbeef Roasbeef merged commit 8e53942 into btcsuite:master Jan 24, 2024
3 checks passed
@Halimao Halimao deleted the refactor/make-help branch January 24, 2024 05:47
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.

5 participants