Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SR-14645] Invalid/Misleading swift package compute-checksum --help #4419

Closed
krzyzanowskim opened this issue May 18, 2021 · 2 comments
Closed
Labels

Comments

@krzyzanowskim
Copy link
Contributor

Previous ID SR-14645
Radar rdar://problem/78189003
Original Reporter @krzyzanowskim
Type Bug
Additional Detail from JIRA
Votes 0
Component/s Package Manager
Labels Bug
Assignee None
Priority Medium

md5: 5655e594ede4044806dd392f2b4f35d8

Issue Description:

Information returned by `swift package compute-checksum --help` is not very helpful and looks like an error. The usage says

swift package compute-checksum <options>

then

ARGUMENTS:
<path> The absolute or relative path to the binary artifact

one may expect the usage is:

❯ swift package compute-checksum MyFramework.xcframework.zip
error: root manifest not found

but it's not. It looks like it expect "any" manifest file in current path, that is unexpected.

Swift Package Manager - Swift 5.4.0

full output

❯ swift package compute-checksum --help
OVERVIEW: Compute the checksum for a binary artifact.
USAGE: swift package compute-checksum <options>
ARGUMENTS:
 <path> The absolute or relative path to the binary artifact
OPTIONS:
 -Xcc <Xcc> Pass flag through to all C compiler invocations
 -Xswiftc <Xswiftc> Pass flag through to all Swift compiler invocations
 -Xlinker <Xlinker> Pass flag through to all linker invocations
 -Xcxx <Xcxx> Pass flag through to all C++ compiler invocations
 -c, --configuration <configuration>
 Build with configuration (default: debug)
 --build-path <build-path>
 Specify build/cache directory
 --cache-path <cache-path>
 Specify the shared cache directory
 --enable-repository-cache/--disable-repository-cache
 Use a shared cache when fetching repositories (default: true)
 -C, --chdir <chdir>
 --package-path <package-path>
 Change working directory before any other operation
 --multiroot-data-file <multiroot-data-file>
 --enable-prefetching/--disable-prefetching
 (default: true)
 -v, --verbose Increase verbosity of informational output
 --disable-sandbox Disable using the sandbox when executing subprocesses
 --manifest-cache <manifest-cache>
 Caching mode of Package.swift manifests (shared: shared cache, local: package's build
 directory, none: disabled (default: shared)
 --destination <destination>
 --triple <triple>
 --sdk <sdk>
 --toolchain <toolchain>
 --static-swift-stdlib/--no-static-swift-stdlib
 Link Swift stdlib statically (default: false)
 --skip-update Skip updating dependencies from their remote during a resolution
 --sanitize <sanitize> Turn on runtime checks for erroneous behavior, possible values: address, thread, undefined,
 scudo
 --enable-code-coverage/--disable-code-coverage
 Enable code coverage (default: false)
 --force-resolved-versions, --disable-automatic-resolution
 Disable automatic resolution if Package.resolved file is out-of-date
 --enable-index-store/--disable-index-store
 Enable or disable indexing-while-building feature
 --enable-parseable-module-interfaces
 --trace-resolver
 -j, --jobs <jobs> The number of jobs to spawn in parallel during the build process
 --enable-build-manifest-caching/--disable-build-manifest-caching
 (default: true)
 --emit-swift-module-separately
 --use-integrated-swift-driver
 --experimental-explicit-module-build
 --print-manifest-job-graph
 Write the command graph for the build manifest as a graphviz file
 --build-system <build-system>
 (default: native)
 --netrc
 --netrc-optional
 --netrc-file <netrc-file>
 --version Show the version.
 -help, -h, --help Show help information.
@typesanitizer
Copy link

@swift-ci create

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 4, 2022
@tomerd
Copy link
Member

tomerd commented Jun 3, 2022

this is fixed in main

@tomerd tomerd closed this as completed Jun 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants