Skip to content

Commit f9bb03b

Browse files
authored
docs: add note about new executable name in migration guide (#2403)
It is a subtle difference to notice in all the examples that the executable name has changed from using underscores to hyphens. It is helpful to the reader to have this explicitly pointed out, the same way that the other changes have been spelled out.
1 parent 110a105 commit f9bb03b

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

migration-guide.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,26 @@ and then attempt to use a private IP. In v2, the Proxy now defaults to public
3434
IP without trying private IP. If you want to use private IP, you must pass
3535
either the `--private-ip` flag or the query parameter. See the README for details.
3636

37-
In some cases, the v1 behavior may be preferrable. Use the `--auto-ip` flag to
37+
In some cases, the v1 behavior may be preferable. Use the `--auto-ip` flag to
3838
mimic v1 behavior. We generally recommend using deterministic IP address selection,
3939
but recognize in some legacy environments `--auto-ip` may be necessary.
4040

41+
## Executable Name Change
42+
43+
Note that the name of the executable has changed, using hyphens rather than underscores:
44+
45+
```shell
46+
# v1
47+
./cloud_sql_proxy
48+
```
49+
50+
vs
51+
52+
```shell
53+
# v2
54+
./cloud-sql-proxy
55+
```
56+
4157
## Sample Invocations
4258

4359
### Listen on TCP socket

0 commit comments

Comments
 (0)