You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: Sources/swift-container-plugin/Documentation.docc/build-container-image.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,16 +34,16 @@ Wrap a binary in a container image and publish it.
34
34
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.
35
35
36
36
- term `--username <username>`:
37
-
Username to use when logging into the registry.
37
+
Default username to use when logging into the registry.
38
38
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.
39
40
The same username is used for the source and destination registries.
40
-
The `.netrc` file is ignored when this option is specified.
41
41
42
42
- term `--password <password>`:
43
-
Password to use when logging into the registry.
43
+
Default password to use when logging into the registry.
44
44
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.
45
46
The same password is used for the source and destination registries.
46
-
The `.netrc` file is ignored when this option is specified.
0 commit comments