docs(config): add GRYPE_CONFIG docs #2380
Open
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: kema-dev <[email protected]>
kema-dev
force-pushed
the
docs(config)-add-GRYPE_CONFIG-docs
branch
from
7a5c942 to
9b25331
Compare
kzantow
reviewed
Jan 21, 2025
README.md
Outdated
| @@ -673,10 +673,13 @@ Default configuration search paths (see all with `grype config locations`): | |||
| Use `grype config` to print a sample config file to stdout. | |||
| Use `grype config --load` to print the current config after loading all values to stdout. | |||
|
|
|||
| You can specify files directly using the `--config` / `-c` flags to provide your own configuration files/paths: | |||
| You can specify files directly using the environment variable `GRYPE_CONFIG` or the `--config` / `-c` flags to provide your own configuration files/paths: | |||
There was a problem hiding this comment.
I don't think we need to include an example of this, since someone specifying this on the command line probably would just use -c and that would be the preferred way rather than using an environment variable that could be overridden. I think it would make sense to revert the dependency here, but add a blurb secondary to the -c, so something like:
You can specify files directly using the
--config/-cflags (or environment variableGRYPE_CONFIG) to provide your own configuration files/paths:
... would this have been sufficient for you to discover this detail?
Signed-off-by: kema <[email protected]>
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.
Why
GRYPE_CONFIGcan be used to do so! I would like to clarify the docs about this possibility.How
(Also added some whitespace tidying)