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

Add Help Command to Makefile #2808

Open
nueavv opened this issue Sep 22, 2024 · 0 comments
Open

Add Help Command to Makefile #2808

nueavv opened this issue Sep 22, 2024 · 0 comments
Labels
kind/feature New feature or request

Comments

@nueavv
Copy link

nueavv commented Sep 22, 2024

Proposal / RFE
Is your feature request related to a problem?

Currently, users lack an easy way to see the available commands in the Makefile, which can lead to confusion.

Describe the solution you'd like

I propose adding a help command to the Makefile that outputs the available commands along with their descriptions. This will help users quickly understand how to use the tool.

For example, the help command could display output like this:

Available commands:
  cilium            Build the Cilium binary.
  release           Create a release of the binary.
  local-release     Build binaries for local environment.
  install           Install the Cilium binary.
  clean             Remove the binary and release files.
  test              Run tests with race detection and coverage.
  bench             Run benchmarks.
  check             Run lint checks on the code.
  clean-tags        Remove generated tags and cscope files.
  tags              Generate tags for the source code.

Adding this feature will enhance the user experience and reduce confusion regarding command usage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant