Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
49905: cliflags: fix the desc for the socket-dir flag r=tbg a=knz

(found by @tbg)

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.


Co-authored-by: Raphael 'kena' Poss <[email protected]>
  • Loading branch information
craig[bot] and knz committed Jun 5, 2020
2 parents d411572 + 2676d75 commit 326cb32
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions pkg/cli/cliflags/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 326cb32

Please sign in to comment.