Fix usage & error reporting in SSL programs #7844
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Manuel Pégourié-Gonnard <[email protected]>
All options have reasonable default so the programs don't need arguments to do something useful. It is widely accepted for programs that can work without arguments need not insist on the user passing arguments, see 'ls', 'wc', 'sort', 'more' and any number of POSIX utilities that all work without arguments. It is also the historical behaviour of those programs, and something relied one by at least a few team members. Signed-off-by: Manuel Pégourié-Gonnard <[email protected]>
Every now and then, I see of these programs failing with a super-long usage message that gives no clue as to what went wrong. (Recently it happened with a test case in ssl-opt.sh with a fairly long command line that was entirely correct, except some options were not valid in this config - the test should have been skipped but wasn't due to some other bug. It took me longer to figure out than it should have, and could have if the program had simply reported which param was not recognized.) Also, have an explicit "help" command, separate "help_ciphersuites", and have default usage message that's not multiple screens long. Signed-off-by: Manuel Pégourié-Gonnard <[email protected]>
mpg
added
needs-review
|
The error reporting looks clean now, and identifying the issue is much easier. Thanks :) |
gowthamsk-arm
approved these changes
Jul 11, 2023
gilles-peskine-arm
approved these changes
Aug 23, 2023
|
I've pushed a merge of the target branch to get fresh CI results. |
gilles-peskine-arm
approved these changes
Aug 23, 2023
There was a problem hiding this comment.
I hereby assert that the commit I pushed to this branch is a merge of the target branch. This can easily be checked on GitHub.
3 tasks
gilles-peskine-arm
added
approved
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is mostly trying to improve on things which have been annoying me regularly. (I've already written the part about reporting what exactly went wrong more that once locally.) The goal is not for everything to be perfect, just better than the status quo.
PR checklist