Skip to content

Commit 5cf0cbe

Browse files
authored
docs: Correct help text for --username and --password (#121)
Motivation ---------- The help text for `--username` and `--password` states that these options override `.netrc`. In fact they are used as defaults if no suitable entry is found in `.netrc`. Modifications ------------- Correct the `--help` option descriptions and manual page. Result ------ Help and documentation accurately describe what the options do. Test Plan --------- All existing tests continue to pass. No functional change.
1 parent 9d3337b commit 5cf0cbe

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Sources/swift-container-plugin/Documentation.docc/build-container-image.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,16 @@ Wrap a binary in a container image and publish it.
3434
If the `product` being packaged has a [resource bundle](https://developer.apple.com/documentation/xcode/bundling-resources-with-a-swift-package) it will be added to the image automatically.
3535

3636
- term `--username <username>`:
37-
Username to use when logging into the registry.
37+
Default username to use when logging into the registry.
3838

39+
This username is used if there is no matching `.netrc` entry for the registry, there is no `.netrc` file, or the `--disable-netrc` option is set.
3940
The same username is used for the source and destination registries.
40-
The `.netrc` file is ignored when this option is specified.
4141

4242
- term `--password <password>`:
43-
Password to use when logging into the registry.
43+
Default password to use when logging into the registry.
4444

45+
This password is used if there is no matching `.netrc` entry for the registry, there is no `.netrc` file, or the `--disable-netrc` option is set.
4546
The same password is used for the source and destination registries.
46-
The `.netrc` file is ignored when this option is specified.
4747

4848
- term `-v, --verbose`:
4949
Verbose output.

0 commit comments

Comments
 (0)