Skip to content

Commit a19d241

Browse files
committed
Add help and documentation comments for --netrc flag and --netrc-file-path option
1 parent e824ef7 commit a19d241

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Sources/Commands/Options.swift

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -315,20 +315,20 @@ public struct SwiftToolOptions: ParsableArguments {
315315
archs.count > 1 ? .xcode : _buildSystem
316316
}
317317

318-
/// Tells `Workspace` to attempt to locate .netrc file at `NSHomeDirectory`.
319-
@Flag(inversion: .prefixedNo)
318+
/// Whether to load .netrc files for authenticating with remote servers
319+
/// when downloading binary artifacts or communicating with a registry.
320+
@Flag(inversion: .prefixedNo, help: "Load credentials from a .netrc file")
320321
var netrc: Bool = true
321322

322-
/// Similar to `--netrc`, but this option makes the .netrc usage optional and not mandatory as with the `--netrc` option.
323323
@available(*, deprecated, message: ".netrc files are located by default")
324324
@Flag(name: .customLong("netrc-optional"), help: .hidden)
325325
var netrcOptional: Bool = false
326326

327-
/// The path to the netrc file which should be use for authentication when downloading binary target artifacts.
328-
/// Similar to `--netrc`, except that you also provide the path to the actual file to use.
329-
/// This is useful when you want to provide the information in another directory or with another file name.
330-
/// - important: Respects `--netrcOptional` option.
331-
@Option(name: .customLong("netrc-file"), completion: .file())
327+
/// The path to the .netrc file used when `netrc` is `true`.
328+
@Option(
329+
name: .customLong("netrc-file"),
330+
help: "Specify the .netrc file path.",
331+
completion: .file())
332332
var netrcFilePath: AbsolutePath?
333333

334334
public init() {}

0 commit comments

Comments
 (0)