Commit 2676d75d authored by Raphael 'kena' Poss's avatar Raphael 'kena' Poss

cliflags: fix the desc for the socket-dir flag

I had the description field mixed up when I previously
deprecated `--socket` in favor of `--socket-dir`.

Release note (bug fix): The description provided with `--help`
on the CLI for `--socket-dir` and `--socket` has been fixed. They
were invalid since v20.1.0.
parent 69bc0192
......@@ -571,28 +571,29 @@ write its process ID to the specified file.`,
}
Socket = FlagInfo{
Name: "socket",
EnvVar: "COCKROACH_SOCKET",
Name: "socket",
EnvVar: "COCKROACH_SOCKET",
Description: `Deprecated in favor of --socket-dir.`,
}
SocketDir = FlagInfo{
Name: "socket-dir",
EnvVar: "COCKROACH_SOCKET_DIR",
Description: `
Accept client connections using a Unix domain socket with the
given name.
Accept client connections using a Unix domain socket created
in the specified directory.
Note: for compatibility with PostgreSQL clients and drivers,
ensure that the socket name has the form "/path/to/.s.PGSQL.NNNN",
where NNNN is a number. PostgreSQL clients only take a port
number and directory as input and construct the socket name
programmatically.
the generated socket name has the form "/path/to/.s.PGSQL.NNNN",
where NNNN is the port number configured via --listen-addr.
PostgreSQL clients only take a port number and directory as input
and construct the socket name programmatically.
To use, for example: psql -h /path/to -p NNNN ...
`,
}
SocketDir = FlagInfo{
Name: "socket-dir",
EnvVar: "COCKROACH_SOCKET_DIR",
Description: `Deprecated in favor of --socket-dir.`,
}
ClientInsecure = FlagInfo{
Name: "insecure",
EnvVar: "COCKROACH_INSECURE",
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment