Rename two internal targets for clarity (with a common prefix) #1345
Conversation
|
I'm tentatively trying a different target name in swiftlang/swift#84510 (comment) |
|
@swift-ci please test |
d-ronnqvist
changed the title
|
The cross-repo tests, passed here https://ci.swift.org/job/swift-PR-Linux/24867/ so these names (with the "DocC" prefix) don't collide with anything (not that surprising) |
|
@swift-ci please test |
|
I'll run one last cross-repo there swiftlang/swift#84510 (comment) before merging this just to make ensure that it doesn't break the Windows CI—which I have no other way to verify currently. |
|
@swift-ci please test |
|
The cross-repo tests for all platforms (macOS, Linux, Windows) already passed so it is safe to merge this. |
|
@swift-ci please test |
|
@swift-ci please test |
|
I ran another cross-repo test in swiftlang/swift#84510 (comment) to verify that this still doesn't break anything. |
|
@swift-ci please test |
There was a problem hiding this comment.
Suggested fixes for a couple of typos, and built the DocCCommandLine catalog locally to verify it was all still working. Found a legitimate warning and some unrelated warnings which I've reported here as comments but that we can fix in a separate PR.
I'm only expecting the 2 comments about typos to be addressed before giving approval, overall looks good.
Sources/SwiftDocC/SwiftDocC.docc/SwiftDocC/AddingFeatureFlags.md
Outdated
Show resolved
Hide resolved
| ### Command Line Options | ||
|
|
||
| - ``DocCArchiveOption`` | ||
| - ``DocumentationBundleOption`` |
There was a problem hiding this comment.
FYI: This type has been renamed to DocumentationCatalogOption -- we can fix it in a subsequent PR.
| DocCCommandLine provides a default, command-line workflow for DocC, powered by Swift [Argument Parser](https://apple.github.io/swift-argument-parser/documentation/argumentparser/). `docc` commands, such as `convert` and `preview`, are conformant ``Action`` types that use DocC to perform documentation tasks. | ||
|
|
||
| Use SwiftDocCUtilities to build a custom, command-line interface and extend it with additional commands. To add a new sub-command called `example`, create a conformant ``Action`` type, `ExampleAction`, that performs the desired work, and add it as a sub-command. Optionally, you can also reuse any of the provided actions like ``ConvertAction``. | ||
| Use DocCCommandLine to build a custom, command-line interface and extend it with additional commands. To add a new sub-command called `example`, create a conformant ``Action`` type, `ExampleAction`, that performs the desired work, and add it as a sub-command. Optionally, you can also reuse any of the provided actions like ``ConvertAction``. |
There was a problem hiding this comment.
FYI: The Action type no longer exists, it is now called AsyncAction but it has package-level access so the symbol is not accessible in the catalog. We can fix this in a subsequent PR.
| - ``Action`` | ||
| - ``ActionResult`` | ||
| - ``RecreatingContext`` |
There was a problem hiding this comment.
FYI: Both Action and RecreatingContext types no longer exist. Action is now called AsyncAction, but not sure whether RecreatingContext has been renamed or no longer exists. We can fix this in a subsequent PR.
|
@swift-ci please test |
Thanks. I fixed those two typos in b7bb045. |
d-ronnqvist
deleted the
revert-1342-revert-1330-rename-target-for-clarity
branch
This reverts #1342 and adds a "DocC" prefix to targets so that they don't conflict with other packages in the toolchain