[clang-format][doc] fix documentation for clang-format

[PeterChou1]

Fixes typo in documentation for clang-format

Fixes #83207.

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be
notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write
permissions for the repository. In which case you can instead tag reviewers by
name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review
by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate
is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-clang-format

@llvm/pr-subscribers-clang

Author: None (PeterChou1)

Changes

Fixes typo in documentation for clang-format

see: #83207

---

Full diff: https://github.com/llvm/llvm-project/pull/83415.diff

1 Files Affected:

• (modified) clang/docs/ClangFormatStyleOptions.rst (+10-10)

diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst
index df399a229d8d4f..5b00a8f4c00fb8 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -318,9 +318,9 @@ the configuration (without a prefix: ``Auto``).
 
   .. code-block:: c++
 
-    AlignConsecutiveMacros: AcrossEmptyLines
+    AlignConsecutiveAssignments: AcrossEmptyLines
 
-    AlignConsecutiveMacros:
+    AlignConsecutiveAssignments:
       Enabled: true
       AcrossEmptyLines: true
       AcrossComments: false
@@ -460,9 +460,9 @@ the configuration (without a prefix: ``Auto``).
 
   .. code-block:: c++
 
-    AlignConsecutiveMacros: AcrossEmptyLines
+    AlignConsecutiveBitFields: AcrossEmptyLines
 
-    AlignConsecutiveMacros:
+    AlignConsecutiveBitFields:
       Enabled: true
       AcrossEmptyLines: true
       AcrossComments: false
@@ -602,9 +602,9 @@ the configuration (without a prefix: ``Auto``).
 
   .. code-block:: c++
 
-    AlignConsecutiveMacros: AcrossEmptyLines
+    AlignConsecutiveDeclarations: AcrossEmptyLines
 
-    AlignConsecutiveMacros:
+    AlignConsecutiveDeclarations:
       Enabled: true
       AcrossEmptyLines: true
       AcrossComments: false
@@ -983,9 +983,9 @@ the configuration (without a prefix: ``Auto``).
 
   .. code-block:: c++
 
-    AlignConsecutiveMacros: AcrossEmptyLines
+    AlignConsecutiveTableGenCondOperatorColons: AcrossEmptyLines
 
-    AlignConsecutiveMacros:
+    AlignConsecutiveTableGenCondOperatorColons:
       Enabled: true
       AcrossEmptyLines: true
       AcrossComments: false
@@ -1123,9 +1123,9 @@ the configuration (without a prefix: ``Auto``).
 
   .. code-block:: c++
 
-    AlignConsecutiveMacros: AcrossEmptyLines
+    AlignConsecutiveTableGenDefinitionColons: AcrossEmptyLines
 
-    AlignConsecutiveMacros:
+    AlignConsecutiveTableGenDefinitionColons:
       Enabled: true
       AcrossEmptyLines: true
       AcrossComments: false

[github-actions]

⚠️ We detected that you are using a GitHub private e-mail address to contribute to the repo.
Please turn off Keep my email addresses private setting in your account.
See LLVM Discourse for more information.

[owenca]

Hi, you need to edit clang/include/clang/Format/Format.h and then run clang/docs/tools/dump_format_style.py to regenerate clang/docs/ClangFormatStyleOptions.rst.

[PeterChou1]

Hi, you need to edit clang/include/clang/Format/Format.h and then run clang/docs/tools/dump_format_style.py to regenerate clang/docs/ClangFormatStyleOptions.rst.

Hi my mistake. I'm quite new to the LLVM project so I was not aware the docs were generated through a script.
I've updated Format.h however I ended up needing to change how the auto generated python doc worked slightly.
The problem was I couldn't carry over the generated member names to the parent type. So I did added a simple search and replace to the generating script so now every time [[[NAME]]] is reference it will use the members name.

I'm not sure if this is the best way to do this though let me know if there's a better method

[owenca]

So I did added a simple search and replace to the generating script so now every time [[[NAME]]] is reference it will use the members name.

Nice! Though why [[[NAME]]] in particular? Can we use <option-name> instead?

[PeterChou1]

So I did added a simple search and replace to the generating script so now every time [[[NAME]]] is reference it will use the members name.

Nice! Though why [[[NAME]]] in particular? Can we use <option-name> instead?

done

[PeterChou1]

Thanks @owenca. I don’t have commit access, can you merge this PR for me?

[github-actions]

@PeterChou1 Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested
by our build bots. If there is a problem with a build, you may recieve a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as
the builds can include changes from many authors. It is not uncommon for your
change to be included in a build that fails due to someone else's changes, or
infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself.
This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!