Cold-Air-Networks/mirror-llvm-project
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 7

[Docs] Update coding standard for TD files (#200848)

Browse source 
This PR proposes an update to the coding standards document to make
explicit that we do not want unnecessary formatting changes to TD files.

This is in response to this merged PR (#199346), which lead to this RFC
(https://discourse.llvm.org/t/80-column-limit-for-td-files/90950/).

---------

Co-authored-by: Vlad Serebrennikov <serebrennikov.vladislav@gmail.com>
This commit is contained in:
Renato Golin 2026-06-01 21:35:58 +01:00 committed by GitHub
parent 385ba8821c
commit 8b66d829fb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.clang-format-ignore
View file

@ -0,0 +1,3 @@
# Do not attempt to format .td files; we have too many formatting needs across
# the various files to allow automatic formatting.
**/*.td

3
clang/.clang-format-ignore
View file

@ -1,3 +0,0 @@
# Do not attempt to format .td files; we have too many formatting needs across
# the various files to allow automatic formatting.
**/*.td

9
llvm/docs/CodingStandards.rst
View file

@ -463,6 +463,15 @@ for it (vs something else, like 90 columns).
However, documentation files are not source code files, and instead of fitting into 80 columns, they must be formatted to one sentence per line. However, documentation files are not source code files, and instead of fitting into 80 columns, they must be formatted to one sentence per line.
This way a change in the middle of a paragraph doesn't cause unnecessary changes in subsequent lines, making it easier for reviewers to see what has changed when documentation is updated. This way a change in the middle of a paragraph doesn't cause unnecessary changes in subsequent lines, making it easier for reviewers to see what has changed when documentation is updated.
Another exception are TableGen files (.td).
There are no tools that can parse, verify and edit them to match our coding style, including clang-format, so they are excluded from this limit.
It is still good practice to try to fit them into 80 columns, but it is not a requirement.
As with other changes, if you patch a TD file, do not reformat the entire file, but only the lines you are changing.
If your reformatting is causing unnecessary changes in subsequent lines, please just follow the existing formatting.
Unecessary changes in TD files cause unnecessary churn in the file history and force recompilation of many unnecessary files.
It also causes unnecessary changes in forks working on the same TD files, which makes it harder to rebase and merge later.
Whitespace Whitespace
^^^^^^^^^^ ^^^^^^^^^^