CLI command docs (#8642)

Adds documentation into the stubs for current Swift Package commands and
subcommands.

This additionally marks a number of commands that are `hidden` as also
`private` to prevent them from showing up in future dump commands.

The process was somewhat automated, but quite manual - as the current
iteration of the argument parser plugin has issues with dumping docs for
executables that are expected to be run under different names (such as
`swift build`, `swift run`, etc) - which Package Manager hosts, as well
as dumps hidden commands, but not private commands.

resolves #8643

Author: heckj

Sources/Commands/PackageCommands/DumpCommands.swift

@@ -113,7 +113,7 @@ enum ExtensionBlockSymbolBehavior: String, EnumerableFlag {
 
 struct DumpPackage: AsyncSwiftCommand {
     static let configuration = CommandConfiguration(
-        abstract: "Print parsed Package.swift as JSON")
+        abstract: "Print parsed Package.swift as JSON.")
 
     @OptionGroup(visibility: .hidden)
     var globalOptions: GlobalOptions
@@ -141,9 +141,9 @@ struct DumpPackage: AsyncSwiftCommand {
 
 struct DumpPIF: AsyncSwiftCommand {
     // hides this command from CLI `--help` output
-    static let configuration = CommandConfiguration(shouldDisplay: false) 
+    static let configuration = CommandConfiguration(shouldDisplay: false)
 
-    @OptionGroup(visibility: .hidden)
+    @OptionGroup(visibility: .private)
     var globalOptions: GlobalOptions
 
     @Flag(help: "Preserve the internal structure of PIF")

Sources/Commands/PackageCommands/Format.swift

@@ -27,7 +27,7 @@ extension SwiftPackageCommand {
         static let configuration = CommandConfiguration(
             commandName: "_format", shouldDisplay: false)
 
-        @OptionGroup(visibility: .hidden)
+        @OptionGroup(visibility: .private)
         var globalOptions: GlobalOptions
 
         @Argument(parsing: .captureForPassthrough,

Sources/Commands/PackageCommands/Resolve.swift

@@ -72,7 +72,7 @@ extension SwiftPackageCommand {
     struct Fetch: AsyncSwiftCommand {
         static let configuration = CommandConfiguration(shouldDisplay: false)
 
-        @OptionGroup(visibility: .hidden)
+        @OptionGroup(visibility: .private)
         var globalOptions: GlobalOptions
 
         @OptionGroup()

Sources/Commands/PackageCommands/SwiftPackageCommand.swift

@@ -95,7 +95,7 @@ extension SwiftPackageCommand {
             shouldDisplay: false
         )
 
-        @OptionGroup(visibility: .hidden)
+        @OptionGroup(visibility: .private)
         var globalOptions: GlobalOptions
 
         @OptionGroup()

Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddDependency.md

@@ -1,15 +1,296 @@
 # swift package add-dependency
 
-Add a package dependency to the manifest.
-
 @Metadata {
     @PageImage(purpose: icon, source: command-icon)
 }
 
-## Overview
+Add a package dependency to the manifest.
+
+```
+package add-dependency <dependency> [--package-path=<package-path>] [--cache-path=<cache-path>] [--config-path=<config-path>] [--security-path=<security-path>] [--scratch-path=<scratch-path>]     [--swift-sdks-path=<swift-sdks-path>] [--toolset=<toolset>...] [--pkg-config-path=<pkg-config-path>...]   [--enable-dependency-cache|disable-dependency-cache]  [--enable-build-manifest-caching|disable-build-manifest-caching] [--manifest-cache=<manifest-cache>] [--enable-experimental-prebuilts|disable-experimental-prebuilts] [--verbose] [--very-verbose|vv] [--quiet] [--color-diagnostics|no-color-diagnostics] [--disable-sandbox] [--netrc] [--enable-netrc|disable-netrc] [--netrc-file=<netrc-file>] [--enable-keychain|disable-keychain] [--resolver-fingerprint-checking=<resolver-fingerprint-checking>] [--resolver-signing-entity-checking=<resolver-signing-entity-checking>] [--enable-signature-validation|disable-signature-validation] [--enable-prefetching|disable-prefetching] [--force-resolved-versions|disable-automatic-resolution|only-use-versions-from-resolved-file] [--skip-update] [--disable-scm-to-registry-transformation] [--use-registry-identity-for-scm] [--replace-scm-with-registry]  [--default-registry-url=<default-registry-url>] [--configuration=<configuration>] [--=<Xcc>...] [--=<Xswiftc>...] [--=<Xlinker>...] [--=<Xcxx>...]    [--triple=<triple>] [--sdk=<sdk>] [--toolchain=<toolchain>]   [--swift-sdk=<swift-sdk>] [--sanitize=<sanitize>...] [--auto-index-store|enable-index-store|disable-index-store]   [--enable-parseable-module-interfaces] [--jobs=<jobs>] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=<explicit-target-dependency-import-check>] [--experimental-explicit-module-build] [--build-system=<build-system>] [--=<debug-info-format>]      [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--exact=<exact>] [--revision=<revision>] [--branch=<branch>] [--from=<from>] [--up-to-next-minor-from=<up-to-next-minor-from>] [--to=<to>] [--type=<type>] [--version] [--help]
+```
+
+- term **dependency:**
+
+*The URL or directory of the package to add.*
+
+
+- term **--package-path=\<package-path\>:**
+
+*Specify the package path to operate on (default current directory). This changes the working directory before any other operation.*
+
+
+- term **--cache-path=\<cache-path\>:**
+
+*Specify the shared cache directory path.*
+
+
+- term **--config-path=\<config-path\>:**
+
+*Specify the shared configuration directory path.*
+
+
+- term **--security-path=\<security-path\>:**
+
+*Specify the shared security directory path.*
+
+
+- term **--scratch-path=\<scratch-path\>:**
+
+*Specify a custom scratch directory path. (default .build)*
+
+
+- term **--swift-sdks-path=\<swift-sdks-path\>:**
+
+*Path to the directory containing installed Swift SDKs.*
+
+
+- term **--toolset=\<toolset\>:**
+
+*Specify a toolset JSON file to use when building for the target platform. Use the option multiple times to specify more than one toolset. Toolsets will be merged in the order they're specified into a single final toolset for the current build.*
+
+
+- term **--pkg-config-path=\<pkg-config-path\>:**
+
+*Specify alternative path to search for pkg-config `.pc` files. Use the option multiple times to
+specify more than one path.*
+
+
+- term **--enable-dependency-cache|disable-dependency-cache:**
+
+*Use a shared cache when fetching dependencies.*
+
+
+- term **--enable-build-manifest-caching|disable-build-manifest-caching:**
+
+
+- term **--manifest-cache=\<manifest-cache\>:**
+
+*Caching mode of Package.swift manifests. Valid values are: (shared: shared cache, local: package's build directory, none: disabled)*
+
+
+- term **--enable-experimental-prebuilts|disable-experimental-prebuilts:**
+
+*Whether to use prebuilt swift-syntax libraries for macros.*
+
+
+- term **--verbose:**
+
+*Increase verbosity to include informational output.*
+
+
+- term **--very-verbose|vv:**
+
+*Increase verbosity to include debug output.*
+
+
+- term **--quiet:**
+
+*Decrease verbosity to only include error output.*
+
+
+- term **--color-diagnostics|no-color-diagnostics:**
+
+*Enables or disables color diagnostics when printing to a TTY. 
+By default, color diagnostics are enabled when connected to a TTY and disabled otherwise.*
+
+
+- term **--disable-sandbox:**
+
+*Disable using the sandbox when executing subprocesses.*
+
+
+- term **--netrc:**
+
+*Use netrc file even in cases where other credential stores are preferred.*
+
+
+- term **--enable-netrc|disable-netrc:**
+
+*Load credentials from a netrc file.*
+
+
+- term **--netrc-file=\<netrc-file\>:**
+
+*Specify the netrc file path.*
+
+
+- term **--enable-keychain|disable-keychain:**
+
+*Search credentials in macOS keychain.*
+
+
+- term **--resolver-fingerprint-checking=\<resolver-fingerprint-checking\>:**
+
+
+- term **--resolver-signing-entity-checking=\<resolver-signing-entity-checking\>:**
+
+
+- term **--enable-signature-validation|disable-signature-validation:**
+
+*Validate signature of a signed package release downloaded from registry.*
+
+
+- term **--enable-prefetching|disable-prefetching:**
+
+
+- term **--force-resolved-versions|disable-automatic-resolution|only-use-versions-from-resolved-file:**
+
+*Only use versions from the Package.resolved file and fail resolution if it is out-of-date.*
+
+
+- term **--skip-update:**
+
+*Skip updating dependencies from their remote during a resolution.*
+
+
+- term **--disable-scm-to-registry-transformation:**
+
+*Disable source control to registry transformation.*
+
+
+- term **--use-registry-identity-for-scm:**
+
+*Look up source control dependencies in the registry and use their registry identity when possible to help deduplicate across the two origins.*
+
+
+- term **--replace-scm-with-registry:**
+
+*Look up source control dependencies in the registry and use the registry to retrieve them instead of source control when possible.*
+
+
+- term **--default-registry-url=\<default-registry-url\>:**
+
+*Default registry URL to use, instead of the registries.json configuration file.*
+
+
+- term **--configuration=\<configuration\>:**
+
+*Build with configuration*
+
+
+- term **--=\<Xcc\>:**
+
+*Pass flag through to all C compiler invocations.*
+
+
+- term **--=\<Xswiftc\>:**
+
+*Pass flag through to all Swift compiler invocations.*
+
+
+- term **--=\<Xlinker\>:**
+
+*Pass flag through to all linker invocations.*
+
+
+- term **--=\<Xcxx\>:**
+
+*Pass flag through to all C++ compiler invocations.*
+
+
+- term **--triple=\<triple\>:**
+
+
+- term **--sdk=\<sdk\>:**
+
+
+- term **--toolchain=\<toolchain\>:**
+
+
+- term **--swift-sdk=\<swift-sdk\>:**
+
+*Filter for selecting a specific Swift SDK to build with.*
+
+
+- term **--sanitize=\<sanitize\>:**
+
+*Turn on runtime checks for erroneous behavior, possible values: address, thread, undefined, scudo.*
+
+
+- term **--auto-index-store|enable-index-store|disable-index-store:**
+
+*Enable or disable indexing-while-building feature.*
+
+
+- term **--enable-parseable-module-interfaces:**
+
+
+- term **--jobs=\<jobs\>:**
+
+*The number of jobs to spawn in parallel during the build process.*
+
+
+- term **--use-integrated-swift-driver:**
+
+
+- term **--explicit-target-dependency-import-check=\<explicit-target-dependency-import-check\>:**
+
+*A flag that indicates this build should check whether targets only import their explicitly-declared dependencies.*
+
+
+- term **--experimental-explicit-module-build:**
+
+
+- term **--build-system=\<build-system\>:**
+
+
+- term **--=\<debug-info-format\>:**
+
+*The Debug Information Format to use.*
+
+
+- term **--enable-dead-strip|disable-dead-strip:**
+
+*Disable/enable dead code stripping by the linker.*
+
+
+- term **--disable-local-rpath:**
+
+*Disable adding $ORIGIN/@loader_path to the rpath by default.*
+
+
+- term **--exact=\<exact\>:**
+
+*The exact package version to depend on.*
+
+
+- term **--revision=\<revision\>:**
+
+*The specific package revision to depend on.*
+
+
+- term **--branch=\<branch\>:**
+
+*The branch of the package to depend on.*
+
+
+- term **--from=\<from\>:**
+
+*The package version to depend on (up to the next major version).*
+
+
+- term **--up-to-next-minor-from=\<up-to-next-minor-from\>:**
+
+*The package version to depend on (up to the next minor version).*
+
+
+- term **--to=\<to\>:**
+
+*Specify upper bound on the package version range (exclusive).*
+
+
+- term **--type=\<type\>:**
+
+*Specify dependency type.*
+
+
+- term **--version:**
+
+*Show the version.*
+
 
-overview content here....
+- term **--help:**
 
-### First Section
+*Show help information.*
 
-First section content