diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddDependency.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddDependency.md index 31457d2198a..61328cf8e14 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddDependency.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddDependency.md @@ -7,7 +7,50 @@ Add a package dependency to the manifest. ``` -package add-dependency [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--exact=] [--revision=] [--branch=] [--from=] [--up-to-next-minor-from=] [--to=] [--type=] [--version] [--help] +package add-dependency + [--package-path=] [--cache-path=] + [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--exact=] + [--revision=] [--branch=] [--from=] + [--up-to-next-minor-from=] + [--to=] [--type=] [--version] [--help] ``` - term **dependency**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddProduct.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddProduct.md index 9f1bc51e7fd..52813746224 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddProduct.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddProduct.md @@ -7,7 +7,47 @@ Add a new product to the manifest. ``` -package add-product [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--type=] [--targets=...] [--version] [--help] +package add-product [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--type=] + [--targets=...] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddSetting.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddSetting.md index 954ae4945bf..49da6dde0cd 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddSetting.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddSetting.md @@ -7,7 +7,47 @@ Add a new setting to the manifest. ``` -package add-setting [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] --target= --swift=... [--version] [--help] +package add-setting [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] --target= + --swift=... [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddTarget.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddTarget.md index f9ff99d1cb4..eaee3e76e04 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddTarget.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddTarget.md @@ -7,7 +7,49 @@ Add a new target to the manifest. ``` -package add-target [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--type=] [--dependencies=...] [--url=] [--path=] [--checksum=] [--testing-library=] [--version] [--help] +package add-target [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--type=] + [--dependencies=...] [--url=] + [--path=] [--checksum=] + [--testing-library=] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddTargetDependency.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddTargetDependency.md index 6ec4729a3ba..f508e4bd570 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddTargetDependency.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageAddTargetDependency.md @@ -7,7 +7,47 @@ Add a new target dependency to the manifest. ``` -package add-target-dependency [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--package=] [--version] [--help] +package add-target-dependency [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] + [--package=] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageArchiveSource.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageArchiveSource.md index 3cc82e185d3..a0e1c2d50c7 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageArchiveSource.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageArchiveSource.md @@ -7,7 +7,47 @@ Create a source archive for the package. ``` -package archive-source [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--output=] [--version] [--help] +package archive-source [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--output=] [--version] + [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageClean.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageClean.md index 815871a5f22..79d3f72875b 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageClean.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageClean.md @@ -7,7 +7,46 @@ Delete build artifacts. ``` -package clean [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package clean [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageCompletionTool.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageCompletionTool.md index bbd55792569..ca75b93c714 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageCompletionTool.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageCompletionTool.md @@ -8,7 +8,46 @@ Command to generate shell completions. ``` -package completion-tool [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package completion-tool [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageComputeChecksum.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageComputeChecksum.md index f940c363bf7..ae182ee8cba 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageComputeChecksum.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageComputeChecksum.md @@ -7,7 +7,46 @@ Compute the checksum for a binary artifact. ``` -package compute-checksum [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package compute-checksum [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigGetMirror.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigGetMirror.md index 758c2c89576..ed47f73ccdd 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigGetMirror.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigGetMirror.md @@ -7,8 +7,47 @@ Print mirror configuration for the given package dependency. ``` -package config get-mirror [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--original=] [--version] [--help] -``` +package config get-mirror [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--original=] [--version] + [--help]``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigSetMirror.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigSetMirror.md index c30b9a2b717..0d540913102 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigSetMirror.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigSetMirror.md @@ -7,7 +7,47 @@ Set a mirror for a dependency. ``` -package config set-mirror [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--original=] [--mirror=] [--version] [--help] +package config set-mirror [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--original=] + [--mirror=] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigUnsetMirror.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigUnsetMirror.md index cd7434684fe..1735e80e255 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigUnsetMirror.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageConfigUnsetMirror.md @@ -7,7 +7,47 @@ Remove an existing mirror. ``` -package config unset-mirror [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--original=] [--mirror=] [--version] [--help] +package config unset-mirror [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--original=] + [--mirror=] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDescribe.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDescribe.md index c405c9cf34d..5743fcfcca6 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDescribe.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDescribe.md @@ -7,7 +7,47 @@ Describe the current package. ``` -package describe [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--type=] [--version] [--help] +package describe [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--type=] [--version] + [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDiagnoseAPIBreakingChange.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDiagnoseAPIBreakingChange.md index 2c045e11e42..62f2efe5a55 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDiagnoseAPIBreakingChange.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDiagnoseAPIBreakingChange.md @@ -8,7 +8,53 @@ Diagnose API-breaking changes to Swift modules in a package. ``` -package diagnose-api-breaking-changes [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--breakage-allowlist-path=] [--products=...] [--targets=...] [--traits=] [--enable-all-traits] [--disable-default-traits] [--baseline-dir=] [--regenerate-baseline] [--version] [--help] +package diagnose-api-breaking-changes + [--package-path=] [--cache-path=] + [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] + [--breakage-allowlist-path=] + [--products=...] + [--targets=...] [--traits=] + [--enable-all-traits] [--disable-default-traits] + [--baseline-dir=] [--regenerate-baseline] + [--version] [--help] ``` The diagnose-api-breaking-changes command can be used to compare the Swift API of a package to a baseline revision, diagnosing any breaking changes which have been introduced. By default, it compares every Swift module from the baseline revision which is part of a library product. For packages with many targets, this behavior may be undesirable as the comparison can be slow. The `--products` and `--targets` options may be used to restrict the scope of the comparison. diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDumpPackage.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDumpPackage.md index 031727b1b79..5bd057c68e9 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDumpPackage.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDumpPackage.md @@ -7,7 +7,46 @@ Print parsed Package.swift as JSON. ``` -package dump-package [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package dump-package [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDumpSymbolGraph.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDumpSymbolGraph.md index 70a6cf228c2..fd750f977bc 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDumpSymbolGraph.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageDumpSymbolGraph.md @@ -7,7 +7,51 @@ Dump symbol graphs. ``` -package dump-symbol-graph [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--pretty-print] [--skip-synthesized-members] [--minimum-access-level=] [--skip-inherited-docs] [--include-spi-symbols] [--emit-extension-block-symbols|omit-extension-block-symbols] [--version] [--help] +package dump-symbol-graph [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--pretty-print] + [--skip-synthesized-members] + [--minimum-access-level=] + [--skip-inherited-docs] [--include-spi-symbols] + [--emit-extension-block-symbols] + [--omit-extension-block-symbols] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageEdit.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageEdit.md index 719f210be5a..34e57010399 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageEdit.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageEdit.md @@ -7,7 +7,48 @@ Put a package in editable mode. ``` -package edit [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--revision=] [--branch=] [--path=] [--version] [--help] +package edit [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--revision=] + [--branch=] [--path=] + [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageExperimentalInstall.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageExperimentalInstall.md index 40607877c95..816ff560e68 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageExperimentalInstall.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageExperimentalInstall.md @@ -7,7 +7,47 @@ Offers the ability to install executable products of the current package. ``` -package experimental-install [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--product=] [--version] [--help] +package experimental-install [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--product=] [--version] + [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageExperimentalUninstall.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageExperimentalUninstall.md index 4c347948893..f2adf2db331 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageExperimentalUninstall.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageExperimentalUninstall.md @@ -7,7 +7,47 @@ Offers the ability to uninstall executable products previously installed by `swift package experimental-install`. ``` -package experimental-uninstall [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package experimental-uninstall + [--package-path=] [--cache-path=] + [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageInit.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageInit.md index ad5e1e501be..c7afb172555 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageInit.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageInit.md @@ -7,7 +7,49 @@ Initialize a new package. ``` -package init [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--type=] [--enable-xctest|disable-xctest] [--enable-swift-testing|disable-swift-testing] [--name=] [--version] [--help] +package init [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--type=] [--enable-xctest] + [--disable-xctest] [--enable-swift-testing] + [--disable-swift-testing] [--name=] [--version] + [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageMigrate.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageMigrate.md index d5efca843a8..55ecd763a76 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageMigrate.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageMigrate.md @@ -8,7 +8,47 @@ Migrate a package or its individual targets to use the given set of features. ``` -package migrate [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--targets=] --to-feature=... [--version] [--help] +package migrate [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--target=] + --to-feature= [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackagePlugin.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackagePlugin.md index a2bbe94c115..a98d3589a89 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackagePlugin.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackagePlugin.md @@ -9,7 +9,51 @@ Invoke a command plugin or perform other actions on command plugins. ``` -package plugin [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--list] [--allow-writing-to-package-directory] [--allow-writing-to-directory=...] [--allow-network-connections=] [--package=] [] [...] [--version] [--help] +package plugin [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--list] + [--allow-writing-to-package-directory] + [--allow-writing-to-directory=...] + [--allow-network-connections=] + [--package=] [] [...] + [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackagePurgeCache.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackagePurgeCache.md index 5d2a5a5a97a..ba7127f7a67 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackagePurgeCache.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackagePurgeCache.md @@ -7,7 +7,46 @@ Purge the global repository cache. ``` -package purge-cache [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package purge-cache [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageReset.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageReset.md index 586bb165173..8148b3ba7e4 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageReset.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageReset.md @@ -7,7 +7,46 @@ Reset the complete cache/build directory. ``` -package reset [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package reset [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageResolve.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageResolve.md index 0e4c3a25cec..87a0fec18be 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageResolve.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageResolve.md @@ -7,7 +7,49 @@ Resolve package dependencies. ``` -package resolve [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] --version= [--branch=] [--revision=] [] [--traits=] [--enable-all-traits] [--disable-default-traits] [--version] [--help] +package resolve [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] --version= + [--branch=] [--revision=] + [] [--traits=] [--enable-all-traits] + [--disable-default-traits] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageShowDependencies.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageShowDependencies.md index e5be75d2275..5489457acc7 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageShowDependencies.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageShowDependencies.md @@ -7,7 +7,47 @@ Print the resolved dependency graph. ``` -package show-dependencies [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--format=] [--output-path=] [--version] [--help] +package show-dependencies [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--format=] + [--output-path=] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageShowExecutables.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageShowExecutables.md index 0ac0a090485..209f44e8a78 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageShowExecutables.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageShowExecutables.md @@ -7,7 +7,47 @@ List the available executables from this package. ``` -package show-executables [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--format=] [--version] [--help] +package show-executables [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--format=] [--version] + [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageToolsVersion.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageToolsVersion.md index 704da4ecc63..c643c30d5a5 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageToolsVersion.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageToolsVersion.md @@ -7,7 +7,47 @@ Manipulate tools version of the current package. ``` -package tools-version [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--set-current] [--set=] [--version] [--help] +package tools-version [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--set-current] [--set=] + [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageUnedit.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageUnedit.md index 5be1abe9e0e..b6f25c8896a 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageUnedit.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageUnedit.md @@ -7,7 +7,47 @@ Remove a package from editable mode. ``` -package unedit [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--force] [--version] [--help] +package unedit [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--force] + [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageUpdate.md b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageUpdate.md index ad9afbba76d..92e0fb83e28 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/Package/PackageUpdate.md +++ b/Sources/PackageManagerDocs/Documentation.docc/Package/PackageUpdate.md @@ -7,7 +7,47 @@ Update package dependencies. ``` -package update [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--dry-run] [...] [--version] [--help] +package update [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--dry-run] [...] + [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionAdd.md b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionAdd.md index 80424594f46..feee3e93abc 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionAdd.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionAdd.md @@ -92,7 +92,48 @@ The `--skip-signature-check` flag has no effects on unsigned collections. ## Usage ``` -package-collection add [--order=] [--trust-unsigned] [--skip-signature-check] [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package-collection add [--order=] + [--trust-unsigned] [--skip-signature-check] + [--package-path=] [--cache-path=] + [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **collection-url**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionDescribe.md b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionDescribe.md index e278d1c39d5..3911c9dd044 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionDescribe.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionDescribe.md @@ -80,7 +80,48 @@ License: MIT ## Usage ``` -package-collection describe [--json] [--version=] [--skip-signature-check] [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package-collection describe [--json] + [--version=] [--skip-signature-check] + [--package-path=] [--cache-path=] + [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--json**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionList.md b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionList.md index d43a8a74501..610716f93c3 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionList.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionList.md @@ -22,7 +22,47 @@ The result can optionally be returned as JSON using `--json` for integration int ## Usage ``` -package-collection list [--json] [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package-collection list [--json] + [--package-path=] [--cache-path=] + [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--json**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionRefresh.md b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionRefresh.md index affd7e64f1c..9febc58e136 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionRefresh.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionRefresh.md @@ -22,7 +22,46 @@ SwiftPM will also automatically refresh data under various conditions, but some ## Usage ``` -package-collection refresh [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package-collection refresh [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionRemove.md b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionRemove.md index 14dd7414c8a..0d842788330 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionRemove.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionRemove.md @@ -19,7 +19,47 @@ Removed "Sample Package Collection" from your package collections. ## Usage ``` -package-collection remove [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package-collection remove + [--package-path=] [--cache-path=] + [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **collection-url**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionSearch.md b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionSearch.md index 5924c9817a6..b665c50a706 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionSearch.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageCollections/PackageCollectionSearch.md @@ -38,7 +38,47 @@ Description: A sweet and swifty YAML parser built on LibYAML. ## Usage ``` -package-collection search [--json] --keywords|module [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--version] [--help] +package-collection search [--json] --keywords --module + [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--version] [--help] ``` - term **--json**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryLogin.md b/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryLogin.md index bd10fbfaa99..5463ff1e35a 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryLogin.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryLogin.md @@ -232,7 +232,49 @@ Package manager updates `registries.json` to indicate that `example-registry.com ### Usage ``` -package-registry login [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [] [--username=] [--password=] [--token=] [--token-file=] [--no-confirm] [--version] [--help] +package-registry login [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [] [--username=] + [--password=] [--token=] + [--token-file=] [--no-confirm] [--version] + [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryLogout.md b/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryLogout.md index 1b5086147b6..53a544d00da 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryLogout.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryLogout.md @@ -46,7 +46,46 @@ See [credential storage](https://github.com/swiftlang/swift-evolution/blob/main/ ### Usage ``` -package-registry logout [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [] [--version] [--help] +package-registry logout [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryPublish.md b/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryPublish.md index c48bd0c3690..74c5b177903 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryPublish.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryPublish.md @@ -40,7 +40,53 @@ For more information on package signing, see ] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--url|registry-url=] [--scratch-directory=] [--metadata-path=] [--signing-identity=] [--private-key-path=] [--cert-chain-paths=...] [--allow-insecure-http] [--dry-run] [--version] [--help] +package-registry publish [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] + [--url|registry-url=] + [--scratch-directory=] + [--metadata-path=] + [--signing-identity=] + [--private-key-path=] + [--cert-chain-paths=...] + [--allow-insecure-http] [--dry-run] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistrySet.md b/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistrySet.md index e99d9935069..8b3cd0720f1 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistrySet.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistrySet.md @@ -67,7 +67,47 @@ To remove a registry assignment, use the [`swift package-registry unset` subcomm ### Usage ``` -package-registry set [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--global] [--scope=] [--allow-insecure-http] [--version] [--help] +package-registry set [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--global] [--scope=] + [--allow-insecure-http] [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryUnset.md b/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryUnset.md index e37ff005f84..5d20d137b82 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryUnset.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageRegistry/PackageRegistryUnset.md @@ -10,7 +10,47 @@ Remove a configured registry. ### Usage ``` -package-registry unset [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--global] [--scope=] [--version] [--help] +package-registry unset [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache] [--disable-dependency-cache] + [--enable-build-manifest-caching] + [--disable-build-manifest-caching] + [--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=] [--enable-keychain] + [--disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store] [--enable-index-store] + [--disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip] [--disable-dead-strip] + [--disable-local-rpath] [--global] [--scope=] + [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageSecurity.md b/Sources/PackageManagerDocs/Documentation.docc/PackageSecurity.md index 1491a586955..ccc1896d41d 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageSecurity.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageSecurity.md @@ -47,7 +47,7 @@ This is applicable to `signing-identity` as well. That is, you can use `signing- If the root of the signing certificate is not in the package manager's default trust store, the package author is responsible for telling package users to include the root certificate in their local [trust roots]() directory, otherwise [signature validation]() may fail upon download because the signing certificate is not trusted. -For more information on signed registry packages, see . +For more information on signed registry packages, see . ##### Validating signed packages @@ -76,7 +76,7 @@ An invalid signing certificate would result in the package manager rejecting the #### Signed package collections -Package collection publishers may [sign a collection to protect its contents]() from tampering. +Package collection publishers may [sign a collection to protect its contents]() from tampering. If a collection is signed, the package manager checks that the signature is valid before importing it; or returns an error if any of these fails: - The file's contents, signature excluded, must match what was used to generate the signature. In other words, this checks to see if the collection was altered after it was signed. diff --git a/Sources/PackageManagerDocs/Documentation.docc/RegistryServerSpecification.md b/Sources/PackageManagerDocs/Documentation.docc/RegistryServerSpecification.md index 5a69389ad75..453497e5564 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/RegistryServerSpecification.md +++ b/Sources/PackageManagerDocs/Documentation.docc/RegistryServerSpecification.md @@ -1327,7 +1327,7 @@ JSON schema below. | `licenseURL` | String | URL of the package release's license document. | | | `originalPublicationTime` | String | Original publication time of the package release in [ISO 8601] format. This can be set if the package release was previously published elsewhere.
A registry should record the publication time independently and include it as `publishedAt` in the [package release metadata response]().
In case both `originalPublicationTime` and `publishedAt` are set, `originalPublicationTime` should be used. | | | `readmeURL` | String | URL of the README specifically for the package release or broadly for the package. | | -| `repositoryURLs` | Array | Code repository URL(s) of the package. It is recommended to include all URL variations (e.g., SSH, HTTPS) for the same repository. This can be an empty array if the package does not have source control representation.
Setting this property is one way through which a registry can obtain repository URL to package identifier mappings for the ["lookup package identifiers registered for a URL" API](). A registry may choose other mechanism(s) for package authors to specify such mappings. | | +| `repositoryURLs` | Array | Code repository URL(s) of the package. It is recommended to include all URL variations (e.g., SSH, HTTPS) for the same repository. This can be an empty array if the package does not have source control representation.
Setting this property is one way through which a registry can obtain repository URL to package identifier mappings for the ["lookup package identifiers registered for a URL" API](). A registry may choose other mechanism(s) for package authors to specify such mappings. | | ###### Author type diff --git a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationReset.md b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationReset.md new file mode 100644 index 00000000000..3fc93abb8cc --- /dev/null +++ b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationReset.md @@ -0,0 +1,112 @@ +# swift sdk configuration reset + +@Metadata { + @PageImage(purpose: icon, source: command-icon) + @Available("Swift", introduced: "6.1") +} + +Resets configuration properties currently applied to a given Swift SDK and target triple. If no specific property is specified, all of them are reset for the Swift SDK. + +``` +sdk configuration reset [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] [--sdk-root-path] + [--swift-resources-path] [--swift-static-resources-path] + [--include-search-path] [--library-search-path] + [--toolset-path] [--version] + [--help] +``` + +- term **--package-path=\**: + +*Specify the package path to operate on (default current directory). This changes the working directory before any other operation.* + + +- term **--cache-path=\**: + +*Specify the shared cache directory path.* + + +- term **--config-path=\**: + +*Specify the shared configuration directory path.* + + +- term **--security-path=\**: + +*Specify the shared security directory path.* + + +- term **--scratch-path=\**: + +*Specify a custom scratch directory path. (default .build)* + + +- term **--swift-sdks-path=\**: + +*Path to the directory containing installed Swift SDKs.* + + +- term **--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=\**: + +*Specify alternative path to search for pkg-config `.pc` files. Use the option multiple times to +specify more than one path.* + + +- term **--sdk-root-path**: + +*Reset custom configuration for a path to a directory containing the SDK root.* + + +- term **--swift-resources-path**: + +*Reset custom configuration for a path to a directory containing Swift resources for dynamic linking.* + + +- term **--swift-static-resources-path**: + +*Reset custom configuration for a path to a directory containing Swift resources for static linking.* + + +- term **--include-search-path**: + +*Reset custom configuration for a path to a directory containing headers.* + + +- term **--library-search-path**: + +*Reset custom configuration for a path to a directory containing libraries.* + + +- term **--toolset-path**: + +*Reset custom configuration for a path to a toolset file.* + + +- term **sdk-id**: + +*An identifier of an already installed Swift SDK. Use the `list` subcommand to see all available identifiers.* + + +- term **target-triple**: + +*A target triple of the Swift SDK specified by `sdk-id` identifier string.* + + +- term **--version**: + +*Show the version.* + + +- term **--help**: + +*Show help information.* diff --git a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationSet.md b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationSet.md index 3f9c988e3e2..a6a623f6497 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationSet.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationSet.md @@ -1,4 +1,4 @@ -# swift sdk configuration reset +# swift sdk configuration set @Metadata { @PageImage(purpose: icon, source: command-icon) @@ -8,7 +8,20 @@ Sets configuration options for installed Swift SDKs. ``` -sdk configuration set [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--sdk-root-path=] [--swift-resources-path=] [--swift-static-resources-path=] [--include-search-path=...] [--library-search-path=...] [--toolset-path=...] [--version] [--help] +sdk configuration set [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--sdk-root-path=] + [--swift-resources-path=] + [--swift-static-resources-path=] + [--include-search-path=...] + [--library-search-path=...] + [--toolset-path=...] + [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationShow.md b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationShow.md index fec755b2144..63684ebab8f 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationShow.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigurationShow.md @@ -8,7 +8,14 @@ Prints all configuration properties currently applied to a given Swift SDK and target triple. ``` -sdk configuration show [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--version] [--help] +sdk configuration show [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigure.md b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigure.md index 5198bcdf4ee..6ca3f523881 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigure.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKConfigure.md @@ -8,7 +8,21 @@ Manages configuration options for installed Swift SDKs. ``` -sdk configure [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--sdk-root-path=] [--swift-resources-path=] [--swift-static-resources-path=] [--include-search-path=...] [--library-search-path=...] [--toolset-path=...] [--reset] [--show-configuration] [--version] [--help] +sdk configure [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--sdk-root-path=] + [--swift-resources-path=] + [--swift-static-resources-path=] + [--include-search-path=...] + [--library-search-path=...] + [--toolset-path=...] [--reset] + [--show-configuration] [--version] + [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKInstall.md b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKInstall.md index c5762d43afb..e6bc091edbd 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKInstall.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKInstall.md @@ -10,7 +10,16 @@ Installs a given Swift SDK bundle to a location discoverable by SwiftPM. If the artifact bundle is at a remote location, it's downloaded to local filesystem first. ``` -sdk install [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--checksum=] [--color-diagnostics|no-color-diagnostics] [--version] [--help] +sdk install [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--checksum=] + [--color-diagnostics] [--no-color-diagnostics] [--version] + [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKList.md b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKList.md index b9828b909b5..c2e8adafead 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKList.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKList.md @@ -8,7 +8,14 @@ Print a list of IDs of available Swift SDKs available on the filesystem. ``` -sdk list [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--version] [--help] +sdk list [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] [--version] + [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKRemove.md b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKRemove.md index 586f56d3432..860bb2727f5 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKRemove.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SDK/SDKRemove.md @@ -8,7 +8,14 @@ Removes a previously installed Swift SDK bundle from the filesystem. ``` -sdk remove [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--version] [--help] +sdk remove [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--version] [--help] ``` - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/SwiftBuild.md b/Sources/PackageManagerDocs/Documentation.docc/SwiftBuild.md index c3093f7cc72..b21d8dfbaca 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SwiftBuild.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SwiftBuild.md @@ -9,10 +9,55 @@ Build sources into binary products. ``` -build [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--build-tests] [--enable-code-coverage|disable-code-coverage] [--show-bin-path] [--print-manifest-job-graph] [--print-pif-manifest-graph] [--target=] [--product=] [--enable-xctest|disable-xctest] [--enable-swift-testing|disable-swift-testing] [--traits=] [--enable-all-traits] [--disable-default-traits] [--static-swift-stdlib|no-static-swift-stdlib] [--version] [--help] +build [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache|disable-dependency-cache] + [--enable-build-manifest-caching|disable-build-manifest-caching] + [--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=] + [--enable-keychain|disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] + [--toolchain=] [--swift-sdk=] + [--sanitize=...] + [--auto-index-store|enable-index-store|disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip|disable-dead-strip] + [--disable-local-rpath] [--build-tests] + [--enable-code-coverage|disable-code-coverage] + [--show-bin-path] [--print-manifest-job-graph] + [--print-pif-manifest-graph] [--target=] + [--product=] [--enable-xctest|disable-xctest] + [--enable-swift-testing|disable-swift-testing] + [--traits=] [--enable-all-traits] + [--disable-default-traits] + [--static-swift-stdlib|no-static-swift-stdlib] + [--version] [--help] ``` -SEE ALSO: swift run, swift package, swift test +SEE ALSO: , , - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/SwiftRun.md b/Sources/PackageManagerDocs/Documentation.docc/SwiftRun.md index 8efcdf77d01..56b032cf065 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SwiftRun.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SwiftRun.md @@ -9,10 +9,49 @@ Build and run an executable product. ``` -run [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--repl] [--debugger] [--run] [--skip-build] [--build-tests] [] [--traits=] [--enable-all-traits] [--disable-default-traits] [...] [--version] [--help] +run [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache|disable-dependency-cache] + [--enable-build-manifest-caching|disable-build-manifest-caching] + [--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=] + [--enable-keychain|disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] [--toolchain=] + [--swift-sdk=] [--sanitize=...] + [--auto-index-store|enable-index-store|disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip|disable-dead-strip] + [--disable-local-rpath] [--repl] [--debugger] [--run] + [--skip-build] [--build-tests] [] + [--traits=] [--enable-all-traits] + [--disable-default-traits] [...] [--version] + [--help] ``` -SEE ALSO: swift build, swift package, swift test +SEE ALSO: , , - term **--package-path=\**: diff --git a/Sources/PackageManagerDocs/Documentation.docc/SwiftSDKCommands.md b/Sources/PackageManagerDocs/Documentation.docc/SwiftSDKCommands.md index da0832df368..5c8f695cd3c 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SwiftSDKCommands.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SwiftSDKCommands.md @@ -30,4 +30,5 @@ Overview of package manager commands here... ### Deprecated Commands - - +- diff --git a/Sources/PackageManagerDocs/Documentation.docc/SwiftTest.md b/Sources/PackageManagerDocs/Documentation.docc/SwiftTest.md index e487ba11544..296d26aa357 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SwiftTest.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SwiftTest.md @@ -9,10 +9,58 @@ Build and run tests. ``` -test [--package-path=] [--cache-path=] [--config-path=] [--security-path=] [--scratch-path=] [--swift-sdks-path=] [--toolset=...] [--pkg-config-path=...] [--enable-dependency-cache|disable-dependency-cache] [--enable-build-manifest-caching|disable-build-manifest-caching] [--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=] [--enable-keychain|disable-keychain] [--resolver-fingerprint-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=] [--configuration=] [--=...] [--=...] [--=...] [--=...] [--triple=] [--sdk=] [--toolchain=] [--swift-sdk=] [--sanitize=...] [--auto-index-store|enable-index-store|disable-index-store] [--enable-parseable-module-interfaces] [--jobs=] [--use-integrated-swift-driver] [--explicit-target-dependency-import-check=] [--build-system=] [--=] [--enable-dead-strip|disable-dead-strip] [--disable-local-rpath] [--skip-build] [--enable-xctest|disable-xctest] [--enable-swift-testing|disable-swift-testing] [--attachments-path=] [--parallel|no-parallel] [--num-workers=] [--list-tests] [--show-codecov-path|show-code-coverage-path|show-coverage-path] [--specifier=] [--filter=...] [--skip=...] [--xunit-output=] [--enable-testable-imports|disable-testable-imports] [--enable-code-coverage|disable-code-coverage] [--traits=] [--enable-all-traits] [--disable-default-traits] [--version] [--help] +test [--package-path=] + [--cache-path=] [--config-path=] + [--security-path=] + [--scratch-path=] + [--swift-sdks-path=] + [--toolset=...] + [--pkg-config-path=...] + [--enable-dependency-cache|disable-dependency-cache] + [--enable-build-manifest-caching|disable-build-manifest-caching] + [--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=] + [--enable-keychain|disable-keychain] + [--resolver-fingerprint-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=] + [--configuration=] [--=...] + [--=...] [--=...] [--=...] + [--triple=] [--sdk=] + [--toolchain=] [--swift-sdk=] + [--sanitize=...] + [--auto-index-store|enable-index-store|disable-index-store] + [--enable-parseable-module-interfaces] [--jobs=] + [--use-integrated-swift-driver] + [--explicit-target-dependency-import-check=] + [--build-system=] [--=] + [--enable-dead-strip|disable-dead-strip] + [--disable-local-rpath] [--skip-build] + [--enable-xctest|disable-xctest] + [--enable-swift-testing|disable-swift-testing] + [--attachments-path=] + [--parallel|no-parallel] [--num-workers=] + [--list-tests] + [--show-codecov-path|show-code-coverage-path|show-coverage-path] + [--specifier=] [--filter=...] + [--skip=...] [--xunit-output=] + [--enable-testable-imports|disable-testable-imports] + [--enable-code-coverage|disable-code-coverage] + [--traits=] [--enable-all-traits] + [--disable-default-traits] [--version] [--help] ``` -SEE ALSO: swift build, swift run, swift package +SEE ALSO: , , - term **--package-path=\**: