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-13254] [docs] Add documentation on how to format changes for a PR using clang-format #55694

Closed
typesanitizer opened this issue Jul 19, 2020 · 3 comments
Closed

[SR-13254] [docs] Add documentation on how to format changes for a PR using clang-format #55694

typesanitizer opened this issue Jul 19, 2020 · 3 comments
Assignees
@typesanitizer
Labels
compiler The Swift compiler in itself task

Comments

@typesanitizer
Copy link

Previous ID SR-13254
Radar rdar://problem/65794436
Original Reporter @typesanitizer
Type Task
Status Closed
Resolution Done
Additional Detail from JIRA
Votes 0
Component/s Compiler
Labels Task
Assignee @typesanitizer
Priority Medium

md5: 907382441a89692c96acda24e22b811e

Issue Description:

We should write step-by-step instructions so we can point people to it, instead of having each new contributor figure out how to invoke `clang-format-diff.py` properly.

This how-to guide should cover:

  1. If clang-format needs to be on your PATH or not.

  2. How to apply the formatting non-destructively, check the changes, and then collapse the changes properly. Sometimes clang-format is too aggressive and touches lines which are not changed by a patch.

  3. How to format all the commits in a PR.
@typesanitizer
Copy link
Author

@swift-ci create

@typesanitizer
Copy link
Author

Related forum thread: https://forums.swift.org/t/automation-for-code-formatting/38568

@typesanitizer
Copy link
Author

Fixed in new FAQ document.

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@typesanitizer typesanitizer

Labels
compiler The Swift compiler in itself task
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@typesanitizer