[clang] [clang-format][doc] Add clarification to `PointerAlignment` (PR #96069)

via cfe-commits cfe-commits at lists.llvm.org
Wed Jun 19 06:29:59 PDT 2024


llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-clang

Author: Eberhard Beilharz (ermshiperete)

<details>
<summary>Changes</summary>

Clarify that `PointerAlignment` is not used if `DerivePointerAlignment` is set to `true`. So far this was only mentioned under `DerivePointerAlignment` which could lead to confusion if someone only looked at `PointerAlignment`.

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


1 Files Affected:

- (modified) clang/docs/ClangFormatStyleOptions.rst (+1-1) 


``````````diff
diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst
index bb00c20922d36..a58ba93b41bf8 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -5015,7 +5015,7 @@ the configuration (without a prefix: ``Auto``).
 .. _PointerAlignment:
 
 **PointerAlignment** (``PointerAlignmentStyle``) :versionbadge:`clang-format 3.7` :ref:`ΒΆ <PointerAlignment>`
-  Pointer and reference alignment style.
+  Pointer and reference alignment style. Only used if ``DerivePointerAlignment`` is not ``true``.
 
   Possible values:
 

``````````

</details>


https://github.com/llvm/llvm-project/pull/96069


More information about the cfe-commits mailing list