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 for improved usability #2809

Closed
wants to merge 1 commit into from

Conversation

nueavv
Copy link

@nueavv nueavv commented Sep 22, 2024

Description
This pull request adds a help command to the Makefile, providing users with a clear overview of the available commands and their functionalities.

fixes: #2808

Changes made:

Introduced a help target that outputs the following information in a neatly formatted manner:

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.

Run 'make <command>' to execute a command.
Use 'make help' to see this help message.

This enhancement improves user experience by making it easier to find and understand the available commands in the Makefile.

@asauber
Copy link
Member

asauber commented Oct 2, 2024

Hi @nueavv, thanks for your PR. A couple notes about this change.

Development of the Cilium CLI now happens upstream, in this directory.

https://github.com/cilium/cilium/tree/main/cilium-cli

For active development of the CLI, this help message might be more useful in that context.

The possible confusion here leads me to think that we should consider paring down the makefile in this repo to only the commands that are used by this repo, now that the code has been moved.

With regards to the help message itself, the make targets in this repo are relatively simple, and the risk of the help message becoming innacurate over time, compared to the level of additional information or context that it provides is about equal, so I'm not sure that we need this change.

Given this, I'm going to close this PR for now. Feel free to open it up against the upstream repo to continue the discussion.

@asauber asauber closed this Oct 2, 2024
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.

Add Help Command to Makefile
2 participants