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

Enable clang-format for rustc #756

Closed
1 of 3 tasks
dianqk opened this issue Jun 9, 2024 · 2 comments
Closed
1 of 3 tasks

Enable clang-format for rustc #756

dianqk opened this issue Jun 9, 2024 · 2 comments
Labels
major-change A proposal to make a major change to rustc T-compiler Add this label so rfcbot knows to poll the compiler team

Comments

@dianqk
Copy link
Member

dianqk commented Jun 9, 2024

Proposal

I plan to use clang-format to format the C++ code in compiler/rustc_llvm/llvm-wrapper. The issue originates from: rust-lang/rust#123510.

To achieve this, I intend to integrate clang-format into our LLVM build process. Although adding clang-format will increase maintenance costs, even minor version differences (e.g., between clang-format 18.1.7 and 18.1.6) can lead to formatting discrepancies. Using a consistent build version ensures uniform formatting results, preventing inconsistencies with the CI environment and reducing the difficulties developers face when configuring their environments.

I plan to add new fields in config.toml to control clang-format behavior:

[llvm]
# Use a specified version of clang-format, the most common scenario.
clang-format = '5a5152f653959d14d68613a3a8a033fb65eec021'
# Use a clang-format from a specified path.
clang-format = '/path/to/clang-format'
# Use the same version as the llvm-project submodule; if not available it will build from local.
clang-format = 'submodule'
# For specific reasons, do not use clang-format.
clang-format = false

Mentors or Reviewers

Myself or @workingjubilee.

Process

The main points of the Major Change Process are as follows:

  • File an issue describing the proposal.
  • A compiler team member or contributor who is knowledgeable in the area can second by writing @rustbot second.
    • Finding a "second" suffices for internal changes. If however, you are proposing a new public-facing feature, such as a -C flag, then full team check-off is required.
    • Compiler team members can initiate a check-off via @rfcbot fcp merge on either the MCP or the PR.
  • Once an MCP is seconded, the Final Comment Period begins. If no objections are raised after 10 days, the MCP is considered approved.

You can read more about Major Change Proposals on forge.

Comments

This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

@dianqk dianqk added major-change A proposal to make a major change to rustc T-compiler Add this label so rfcbot knows to poll the compiler team labels Jun 9, 2024
@rustbot
Copy link
Collaborator

rustbot commented Jun 9, 2024

This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

Concerns or objections to the proposal should be discussed on Zulip and formally registered here by adding a comment with the following syntax:

@rustbot concern reason-for-concern 
<description of the concern> 

Concerns can be lifted with:

@rustbot resolve reason-for-concern 

See documentation at https://forge.rust-lang.org

cc @rust-lang/compiler @rust-lang/compiler-contributors

@rustbot rustbot added the to-announce Announce this issue on triage meeting label Jun 9, 2024
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label Jun 14, 2024
@dianqk
Copy link
Member Author

dianqk commented Jun 26, 2024

We can use clang-format provided by pip: https://pypi.org/project/clang-format/.

@dianqk dianqk closed this as not planned Won't fix, can't repro, duplicate, stale Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major-change A proposal to make a major change to rustc T-compiler Add this label so rfcbot knows to poll the compiler team
Projects
None yet
Development

No branches or pull requests

3 participants