Skip to content

Commit 2da3461

Browse files
committed
apply check-doc comments
Signed-off-by: Kyeongwon Seo <[email protected]>
1 parent 142387f commit 2da3461

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

docs/configuration/config-file-reference.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2330,20 +2330,19 @@ The `redis_config` configures the Redis backend cache. The supported CLI flags `
23302330
# CLI flag: -<prefix>.redis.enable-tls
23312331
[enable_tls: <boolean> | default = false]
23322332
2333-
# Close connections after remaining idle for this duration.
2334-
# If the value is zero, then idle connections are not closed.
2333+
# Close connections after remaining idle for this duration. If the value is
2334+
# zero, then idle connections are not closed.
23352335
# CLI flag: -<prefix>.redis.idle-timeout
23362336
[idle_timeout: <duration> | default = 0s]
23372337
2338-
# Enables waiting if there are no idle connections.
2339-
# If the value is false and the pool is at the max_active_conns limit,
2340-
# the pool will return a connection with ErrPoolExhausted error
2341-
# and not wait for idle connections.
2338+
# Enables waiting if there are no idle connections. If the value is false and
2339+
# the pool is at the max_active_conns limit, the pool will return a connection
2340+
# with ErrPoolExhausted error and not wait for idle connections.
23422341
# CLI flag: -<prefix>.redis.wait
23432342
[wait: <boolean> | default = false]
23442343
2345-
# Close connections older than this duration.
2346-
# If the value is zero, then the pool does not close connections based on age.
2344+
# Close connections older than this duration. If the value is zero, then the
2345+
# pool does not close connections based on age.
23472346
# CLI flag: -<prefix>.redis.max-conn-lifetime
23482347
[max_conn_lifetime: <duration> | default = 0s]
23492348
```

pkg/chunk/cache/redis_cache.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ func (cfg *RedisConfig) RegisterFlagsWithPrefix(prefix, description string, f *f
4444
f.Var(&cfg.Password, prefix+"redis.password", description+"Password to use when connecting to redis.")
4545
f.BoolVar(&cfg.EnableTLS, prefix+"redis.enable-tls", false, description+"Enables connecting to redis with TLS.")
4646
f.DurationVar(&cfg.IdleTimeout, prefix+"redis.idle-timeout", 0, description+"Close connections after remaining idle for this duration. If the value is zero, then idle connections are not closed.")
47-
f.BoolVar(&cfg.Wait, prefix+"redis.wait", false, description+"Enables waiting if there are no idle connections.")
47+
f.BoolVar(&cfg.Wait, prefix+"redis.wait", false, description+"Enables waiting if there are no idle connections. If the value is false and the pool is at the max_active_conns limit, the pool will return a connection with ErrPoolExhausted error and not wait for idle connections.")
4848
f.DurationVar(&cfg.MaxConnLifetime, prefix+"redis.max-conn-lifetime", 0, description+"Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.")
4949
}
5050

0 commit comments

Comments
 (0)