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

Jump to bottom

[SR-12083] The compiler documentation for end users is incomplete #54519

Open
swift-ci opened this issue Jan 24, 2020 · 2 comments
Open

[SR-12083] The compiler documentation for end users is incomplete #54519

swift-ci opened this issue Jan 24, 2020 · 2 comments
Labels
bug A deviation from expected or documented behavior. Also: expected but undesirable behavior. compiler The Swift compiler in itself

Comments

@swift-ci
Copy link
Collaborator

Previous ID SR-12083
Radar rdar://problem/58997159
Original Reporter Hacksaw (JIRA User)
Type Bug
Environment

swift 5.1.3, macOS or Linux

Additional Detail from JIRA
Votes 0
Component/s Compiler
Labels Bug
Assignee None
Priority Medium

md5: d866164e78065cdb0af9c8fb89915948

Issue Description:

If you run swift -help, you get a listing of options for the compiler, but the explanation provided is naturally far less than is needed to understand why you might need that option.

What's needed is an exhaustive document describing each option, and any other inputs which can affect the outputs.

Ideally, every option would be described in detail, but it would also be given context, i.e. what problem it solves, and non-trivial examples.
@beccadax
Copy link
Contributor

@swift-ci create

@beccadax
Copy link
Contributor

beccadax commented Feb 4, 2020

This might make sense as an addition to the man page, which is located in the apple/swift repo at swift/docs/tools/swift.pod (and is in Perl's "Plain Old Documentation" format).

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug A deviation from expected or documented behavior. Also: expected but undesirable behavior. compiler The Swift compiler in itself
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@beccadax @swift-ci