-
Notifications
You must be signed in to change notification settings - Fork 394
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
remove help command, create flags markdown docs #3321
Conversation
46a1a52
to
317b8af
Compare
When this is merged, open an issue to generate man pages for flags using the introduced markdown files. |
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.
@geyslan Not sure I understand why we added list-caps
? Also, is the idea to merge into this release, and the man page would only be provided in the upcoming release?
The main branch help capabilities generates the help with a list of available capabilities, as we're removing them (placing in markdowns), we need to provide similar functionality, so after discussion we've decided to make it a flag for the already existent list command |
This removes the default cobra help command, leaving only the root --help flag. The remaining - in code - help flags strings are only used by the old tracee-ebpf command. With this, new binary flags help are inaccessible. To circumvent this, the help flags are now documented in markdown files (not included to online docs) to be used as source for man pages generation (next step). BREAKING CHANGE: help command is gone, use --help flag instead.
We've discussed this offline and decided to remove the available capabilities output for now while we don't set a system/debug option to centralise system information fetching. |
This removes the default cobra help command, leaving only the root --help flag. The remaining - in code - help flags strings are only used by the old tracee-ebpf command. With this, new binary flags help are inaccessible. To circumvent this, the help flags are now documented in markdown files (not included to online docs) to be used as source for man pages generation (next step). BREAKING CHANGE: help command is gone, use --help flag instead. commit: d882cbf (main), cherry-pick
This removes the default cobra help command, leaving only the root --help flag. The remaining - in code - help flags strings are only used by the old tracee-ebpf command. With this, new binary flags help are inaccessible. To circumvent this, the help flags are now documented in markdown files (not included to online docs) to be used as source for man pages generation (next step). BREAKING CHANGE: help command is gone, use --help flag instead. commit: d882cbf (main), cherry-pick
Close #3299
1. Explain what the PR does
5bac134 fix(flags)!: del help cmd, add md files for flags (2023/jul/13) Geyslan Gregório <geyslan@gmail.com>
2. Explain how to test it
Help flag
sudo ./dist/tracee --help
Help command (removed)
sudo ./dist/tracee help
3. Other comments