docs: link warning to both timeout config options #6620
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
katrinleinweber
commented
May 3, 2024
| @@ -140,7 +140,7 @@ func Run(ctx context.Context, opt flag.Options) error { | |||
| var err error | |||
| defer func() { | |||
| if errors.Is(err, context.DeadlineExceeded) { | |||
| log.Warn("Increase --timeout value") | |||
| log.Warn("Provide a higher timeout value, see https://aquasecurity.github.io/trivy/latest/docs/configuration/") | |||
There was a problem hiding this comment.
Or more terse:
Suggested change
| log.Warn("Provide a higher timeout value, see https://aquasecurity.github.io/trivy/latest/docs/configuration/") | |
| log.Warn("Increase timeout value, see https://aquasecurity.github.io/trivy/latest/docs/configuration/") |
?
katrinleinweber
requested review from
chen-keinan,
simar7,
nikpivkin and
knqyf263
as code owners
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
Should these warnings only mention the CLI flag? How about instead linking to a docs page 1 level higher, so that users who encounter these warnings can then pick the relevant way to set their higher timeout?
(Semi-)Related issues
Related PRsChecklist