Improvement: Cleanup the command-line interface. #258
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
…-update` - Provide users with better hint about what the options do. - Note that example is printed, but update is performed in-place. - Maintain backwards compatibility with aliases `--example` and `--update`.
- I/D are common to other compilers (gcc, clang, verilator, yosys/read_verilog) - Maintain backwards compatibility with short aliases.
- Rename internal `single` -> `oneline` to match. Personally, I think it's more descriptive too. - `-1` can be difficult to distinguish from `-l` in some fonts. - Use the same name "oneline" as `git log` which has similar behaviour.
- Slightly more descriptive. - Matches other tools which call them "incdirs". - Matches keyword "+incdir+" used in filelists. - Use alias for backward compatibility.
`Option<DumpFilelistMode>` instead of `DumpFilelistMode`
- Fixes dalance#245 - Based on example: <https://github.com/clap-rs/clap/blob/clap_complete-v3.2.5/clap_complete/examples/completion-derive.rs> - `svlint --dump-completion=bash > /etc/bash_completion.d/svlint` - <https://serverfault.com/questions/506612/standard-place-for-user-defined-bash-completion-d-scripts>
- More consistent with --config-example. - Other --dump-* options produce something useful for debug, but this is not. - Including the word "shell" provides a better hint to users.
- Clarification for readers of the code. - Changes clap's help message to be consistent with `--defines` and `--incdirs`.
DaveMcEwan
changed the title
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.
--example->--config-example--update->--config-update-i/--include->-I/incdir(also consistent with filelist plusarg/keyword)-d->-D--dump-filelist=no.Technically a breaking change, but I doubt it is ever used in practice.
-E+--preprocess-only-1+--oneline(consistent with Git)--shell-completionto print shell completion scripts to STDOUT.