Skip to content

Commit b3b35fb

Browse files
heckjmarcprux
authored andcommitted
Revising DocC content for the CLI commands to be able to read the arguments for the commands (swiftlang#8883)
Updates to all existing CLI reference documentation to make CLI arguments readable. The initial run of the argument parser generator dumped the arguments into a single, concatenated string that ended up being pretty unreadable through DocC. This update fixes that to present the arguments in a wrapped-width code block, aligned at 60 characters to make it easier to read in DocC. This matches the PR being made to swift argument parser to revise the generation of that content: apple/swift-argument-parser#791 Updated the CLI arguments to block formatting for all existing CLI reference documentation pages. The arguments for any of the CLI documents are much easier to read.
1 parent 240f5ec commit b3b35fb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+2025
-58
lines changed

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

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,50 @@
77
Add a package dependency to the manifest.
88

99
```
10-
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>] [--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]
10+
package add-dependency <dependency>
11+
[--package-path=<package-path>] [--cache-path=<cache-path>]
12+
[--config-path=<config-path>]
13+
[--security-path=<security-path>]
14+
[--scratch-path=<scratch-path>]
15+
[--swift-sdks-path=<swift-sdks-path>]
16+
[--toolset=<toolset>...]
17+
[--pkg-config-path=<pkg-config-path>...]
18+
[--enable-dependency-cache] [--disable-dependency-cache]
19+
[--enable-build-manifest-caching]
20+
[--disable-build-manifest-caching]
21+
[--manifest-cache=<manifest-cache>]
22+
[--enable-experimental-prebuilts]
23+
[--disable-experimental-prebuilts] [--verbose]
24+
[--very-verbose|vv] [--quiet] [--color-diagnostics]
25+
[--no-color-diagnostics] [--disable-sandbox] [--netrc]
26+
[--enable-netrc] [--disable-netrc]
27+
[--netrc-file=<netrc-file>] [--enable-keychain]
28+
[--disable-keychain]
29+
[--resolver-fingerprint-checking=<resolver-fingerprint-checking>]
30+
[--resolver-signing-entity-checking=<resolver-signing-entity-checking>]
31+
[--enable-signature-validation]
32+
[--disable-signature-validation] [--enable-prefetching]
33+
[--disable-prefetching]
34+
[--force-resolved-versions|disable-automatic-resolution|only-use-versions-from-resolved-file]
35+
[--skip-update] [--disable-scm-to-registry-transformation]
36+
[--use-registry-identity-for-scm]
37+
[--replace-scm-with-registry]
38+
[--default-registry-url=<default-registry-url>]
39+
[--configuration=<configuration>] [--=<Xcc>...]
40+
[--=<Xswiftc>...] [--=<Xlinker>...] [--=<Xcxx>...]
41+
[--triple=<triple>] [--sdk=<sdk>] [--toolchain=<toolchain>]
42+
[--swift-sdk=<swift-sdk>] [--sanitize=<sanitize>...]
43+
[--auto-index-store] [--enable-index-store]
44+
[--disable-index-store]
45+
[--enable-parseable-module-interfaces] [--jobs=<jobs>]
46+
[--use-integrated-swift-driver]
47+
[--explicit-target-dependency-import-check=<explicit-target-dependency-import-check>]
48+
[--build-system=<build-system>] [--=<debug-info-format>]
49+
[--enable-dead-strip] [--disable-dead-strip]
50+
[--disable-local-rpath] [--exact=<exact>]
51+
[--revision=<revision>] [--branch=<branch>] [--from=<from>]
52+
[--up-to-next-minor-from=<up-to-next-minor-from>]
53+
[--to=<to>] [--type=<type>] [--version] [--help]
1154
```
1255

1356
- term **dependency**:

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

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,47 @@
77
Add a new product to the manifest.
88

99
```
10-
package add-product [--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>] [--build-system=<build-system>] [--=<debug-info-format>] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] <name> [--type=<type>] [--targets=<targets>...] [--version] [--help]
10+
package add-product [--package-path=<package-path>]
11+
[--cache-path=<cache-path>] [--config-path=<config-path>]
12+
[--security-path=<security-path>]
13+
[--scratch-path=<scratch-path>]
14+
[--swift-sdks-path=<swift-sdks-path>]
15+
[--toolset=<toolset>...]
16+
[--pkg-config-path=<pkg-config-path>...]
17+
[--enable-dependency-cache] [--disable-dependency-cache]
18+
[--enable-build-manifest-caching]
19+
[--disable-build-manifest-caching]
20+
[--manifest-cache=<manifest-cache>]
21+
[--enable-experimental-prebuilts]
22+
[--disable-experimental-prebuilts] [--verbose]
23+
[--very-verbose|vv] [--quiet] [--color-diagnostics]
24+
[--no-color-diagnostics] [--disable-sandbox] [--netrc]
25+
[--enable-netrc] [--disable-netrc]
26+
[--netrc-file=<netrc-file>] [--enable-keychain]
27+
[--disable-keychain]
28+
[--resolver-fingerprint-checking=<resolver-fingerprint-checking>]
29+
[--resolver-signing-entity-checking=<resolver-signing-entity-checking>]
30+
[--enable-signature-validation]
31+
[--disable-signature-validation] [--enable-prefetching]
32+
[--disable-prefetching]
33+
[--force-resolved-versions|disable-automatic-resolution|only-use-versions-from-resolved-file]
34+
[--skip-update] [--disable-scm-to-registry-transformation]
35+
[--use-registry-identity-for-scm]
36+
[--replace-scm-with-registry]
37+
[--default-registry-url=<default-registry-url>]
38+
[--configuration=<configuration>] [--=<Xcc>...]
39+
[--=<Xswiftc>...] [--=<Xlinker>...] [--=<Xcxx>...]
40+
[--triple=<triple>] [--sdk=<sdk>] [--toolchain=<toolchain>]
41+
[--swift-sdk=<swift-sdk>] [--sanitize=<sanitize>...]
42+
[--auto-index-store] [--enable-index-store]
43+
[--disable-index-store]
44+
[--enable-parseable-module-interfaces] [--jobs=<jobs>]
45+
[--use-integrated-swift-driver]
46+
[--explicit-target-dependency-import-check=<explicit-target-dependency-import-check>]
47+
[--build-system=<build-system>] [--=<debug-info-format>]
48+
[--enable-dead-strip] [--disable-dead-strip]
49+
[--disable-local-rpath] <name> [--type=<type>]
50+
[--targets=<targets>...] [--version] [--help]
1151
```
1252

1353
- term **--package-path=\<package-path\>**:

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

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,47 @@
77
Add a new setting to the manifest.
88

99
```
10-
package add-setting [--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>] [--build-system=<build-system>] [--=<debug-info-format>] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] --target=<target> --swift=<swift>... [--version] [--help]
10+
package add-setting [--package-path=<package-path>]
11+
[--cache-path=<cache-path>] [--config-path=<config-path>]
12+
[--security-path=<security-path>]
13+
[--scratch-path=<scratch-path>]
14+
[--swift-sdks-path=<swift-sdks-path>]
15+
[--toolset=<toolset>...]
16+
[--pkg-config-path=<pkg-config-path>...]
17+
[--enable-dependency-cache] [--disable-dependency-cache]
18+
[--enable-build-manifest-caching]
19+
[--disable-build-manifest-caching]
20+
[--manifest-cache=<manifest-cache>]
21+
[--enable-experimental-prebuilts]
22+
[--disable-experimental-prebuilts] [--verbose]
23+
[--very-verbose|vv] [--quiet] [--color-diagnostics]
24+
[--no-color-diagnostics] [--disable-sandbox] [--netrc]
25+
[--enable-netrc] [--disable-netrc]
26+
[--netrc-file=<netrc-file>] [--enable-keychain]
27+
[--disable-keychain]
28+
[--resolver-fingerprint-checking=<resolver-fingerprint-checking>]
29+
[--resolver-signing-entity-checking=<resolver-signing-entity-checking>]
30+
[--enable-signature-validation]
31+
[--disable-signature-validation] [--enable-prefetching]
32+
[--disable-prefetching]
33+
[--force-resolved-versions|disable-automatic-resolution|only-use-versions-from-resolved-file]
34+
[--skip-update] [--disable-scm-to-registry-transformation]
35+
[--use-registry-identity-for-scm]
36+
[--replace-scm-with-registry]
37+
[--default-registry-url=<default-registry-url>]
38+
[--configuration=<configuration>] [--=<Xcc>...]
39+
[--=<Xswiftc>...] [--=<Xlinker>...] [--=<Xcxx>...]
40+
[--triple=<triple>] [--sdk=<sdk>] [--toolchain=<toolchain>]
41+
[--swift-sdk=<swift-sdk>] [--sanitize=<sanitize>...]
42+
[--auto-index-store] [--enable-index-store]
43+
[--disable-index-store]
44+
[--enable-parseable-module-interfaces] [--jobs=<jobs>]
45+
[--use-integrated-swift-driver]
46+
[--explicit-target-dependency-import-check=<explicit-target-dependency-import-check>]
47+
[--build-system=<build-system>] [--=<debug-info-format>]
48+
[--enable-dead-strip] [--disable-dead-strip]
49+
[--disable-local-rpath] --target=<target>
50+
--swift=<swift>... [--version] [--help]
1151
```
1252

1353
- term **--package-path=\<package-path\>**:

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

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,49 @@
77
Add a new target to the manifest.
88

99
```
10-
package add-target [--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>] [--build-system=<build-system>] [--=<debug-info-format>] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] <name> [--type=<type>] [--dependencies=<dependencies>...] [--url=<url>] [--path=<path>] [--checksum=<checksum>] [--testing-library=<testing-library>] [--version] [--help]
10+
package add-target [--package-path=<package-path>]
11+
[--cache-path=<cache-path>] [--config-path=<config-path>]
12+
[--security-path=<security-path>]
13+
[--scratch-path=<scratch-path>]
14+
[--swift-sdks-path=<swift-sdks-path>]
15+
[--toolset=<toolset>...]
16+
[--pkg-config-path=<pkg-config-path>...]
17+
[--enable-dependency-cache] [--disable-dependency-cache]
18+
[--enable-build-manifest-caching]
19+
[--disable-build-manifest-caching]
20+
[--manifest-cache=<manifest-cache>]
21+
[--enable-experimental-prebuilts]
22+
[--disable-experimental-prebuilts] [--verbose]
23+
[--very-verbose|vv] [--quiet] [--color-diagnostics]
24+
[--no-color-diagnostics] [--disable-sandbox] [--netrc]
25+
[--enable-netrc] [--disable-netrc]
26+
[--netrc-file=<netrc-file>] [--enable-keychain]
27+
[--disable-keychain]
28+
[--resolver-fingerprint-checking=<resolver-fingerprint-checking>]
29+
[--resolver-signing-entity-checking=<resolver-signing-entity-checking>]
30+
[--enable-signature-validation]
31+
[--disable-signature-validation] [--enable-prefetching]
32+
[--disable-prefetching]
33+
[--force-resolved-versions|disable-automatic-resolution|only-use-versions-from-resolved-file]
34+
[--skip-update] [--disable-scm-to-registry-transformation]
35+
[--use-registry-identity-for-scm]
36+
[--replace-scm-with-registry]
37+
[--default-registry-url=<default-registry-url>]
38+
[--configuration=<configuration>] [--=<Xcc>...]
39+
[--=<Xswiftc>...] [--=<Xlinker>...] [--=<Xcxx>...]
40+
[--triple=<triple>] [--sdk=<sdk>] [--toolchain=<toolchain>]
41+
[--swift-sdk=<swift-sdk>] [--sanitize=<sanitize>...]
42+
[--auto-index-store] [--enable-index-store]
43+
[--disable-index-store]
44+
[--enable-parseable-module-interfaces] [--jobs=<jobs>]
45+
[--use-integrated-swift-driver]
46+
[--explicit-target-dependency-import-check=<explicit-target-dependency-import-check>]
47+
[--build-system=<build-system>] [--=<debug-info-format>]
48+
[--enable-dead-strip] [--disable-dead-strip]
49+
[--disable-local-rpath] <name> [--type=<type>]
50+
[--dependencies=<dependencies>...] [--url=<url>]
51+
[--path=<path>] [--checksum=<checksum>]
52+
[--testing-library=<testing-library>] [--version] [--help]
1153
```
1254

1355
- term **--package-path=\<package-path\>**:

0 commit comments

Comments
 (0)