Skip to content

CLI command docs #8642

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

Merged
merged 19 commits into from
May 13, 2025
Merged

CLI command docs #8642

merged 19 commits into from
May 13, 2025

Conversation

heckj
Copy link
Member

@heckj heckj commented May 8, 2025

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

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

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

resolves #8643

@heckj
Copy link
Member Author

heckj commented May 8, 2025

@swift-ci please test

@heckj heckj merged commit fee72c5 into swiftlang:main May 13, 2025
6 checks passed
@heckj heckj deleted the cli-command-docs branch May 13, 2025 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for the swift CLI commands
2 participants