]> git.ipfire.org Git - thirdparty/ccache.git/commitdiff
doc: Improve description of Redis URLs
authorJoel Rosdahl <joel@rosdahl.net>
Thu, 7 Jul 2022 10:31:19 +0000 (12:31 +0200)
committerJoel Rosdahl <joel@rosdahl.net>
Thu, 7 Jul 2022 13:17:18 +0000 (15:17 +0200)
doc/MANUAL.adoc

index 4f5b00cb9d2335ccf06772e1e29ac1e9159cca74..7595909105e9ed065276386b9b0e66a9e30a5d7a 100644 (file)
@@ -1157,8 +1157,11 @@ The default is *subdirs*.
 
 === Redis storage backend
 
-URL format: `+redis://[[USERNAME:]PASSWORD@]HOST[:PORT][/DBNUMBER]+`
-Alternative: `+redis+unix://[[USERNAME:]PASSWORD@localhost]SOCKET_PATH[?db=DBNUMBER]+`
+URL formats:
+
+`+redis://[[USERNAME:]PASSWORD@]HOST[:PORT][/DBNUMBER]+` +
+`+redis+unix:SOCKET_PATH[?db=DBNUMBER]+` +
+`+redis+unix://[[USERNAME:]PASSWORD@localhost]SOCKET_PATH[?db=DBNUMBER]+`
 
 This backend stores data in a https://redis.io[Redis] (or Redis-compatible)
 server. There are implementations for both memory-based and disk-based storage.
@@ -1179,7 +1182,7 @@ Examples:
 * `+redis://p4ssw0rd@cache.example.com:6379/0|connect-timeout=50+`
 * `+redis+unix:/run/redis.sock+`
 * `+redis+unix:///run/redis.sock+`
-* `+redis+unix://p4ssw0rd@localhost/var/run/redis/redis-server.sock?db=0|connect-timeout=50+`
+* `+redis+unix://p4ssw0rd@localhost/run/redis.sock?db=0+`
 
 Optional attributes: