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

Should --verbose imply --summary? #115

Open
bdarnell opened this issue Oct 24, 2024 · 1 comment
Open

Should --verbose imply --summary? #115

bdarnell opened this issue Oct 24, 2024 · 1 comment
Labels
C:cli CLI components enhancement New feature or request good first issue Good for newcomers

Comments

@bdarnell
Copy link

As I was setting up abi3audit in my CI, my first thought was to run it in --verbose mode so I could confirm it was working. The example shown in the readme contains the line

[17:59:47] 💁 procmaps: 2 extensions scanned; 1 ABI version mismatches and 0
           ABI violations found

So I assumed that --verbose mode would always print something even if everything passed. This turns out to not be true, and after a few "why isn't this doing anything?!?" CI cycles, I found that what I wanted was the --summary flag. IMHO, a --verbose flag implies "output even on success" and so I'd make --verbose imply --summary. Or if you don't want to change the current behavior, I'd appreciate a more prominent mention of the --summary flag in the docs (in the examples section and not just in --help).

@woodruffw
Copy link
Member

Thanks for the report! Yeah, having --verbose imply --summary makes a lot of sense to me (despite having written this tool, I also sometimes forget to pass --summary 😅).

If you're interested in sending a PR with a fix, I'd be happy to review it!

@woodruffw woodruffw added enhancement New feature or request good first issue Good for newcomers C:cli CLI components labels Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:cli CLI components enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants