Improve amtool check-config use and description text #1016
Merged
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.
Not sure if it's just me, but i had to look into the code to understand that check-config:
is used to validate alertmanager config files, and not validate amtool config files. It became clear after running
amtool check-config -h
, but it was not clear when I executedamtool -h
, so I've changed the short description.that I had to pass the config file as a cmd argument, and that it could be one or more. Changed the Use text to give more context on that.
what you think @stuartnelson3 ?