[clang] [clang-format][doc] Add clarification to `PointerAlignment` (PR #96069)
Eberhard Beilharz via cfe-commits
cfe-commits at lists.llvm.org
Wed Jun 19 06:29:00 PDT 2024
https://github.com/ermshiperete created https://github.com/llvm/llvm-project/pull/96069
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`.
>From f4e7548b94015854173030a0144f35ba9491757e Mon Sep 17 00:00:00 2001
From: Eberhard Beilharz <ermshiperete at users.noreply.github.com>
Date: Wed, 19 Jun 2024 15:27:22 +0200
Subject: [PATCH] [clang-format][doc] Add clarification to `PointerAlignment`
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`.
---
clang/docs/ClangFormatStyleOptions.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
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:
More information about the cfe-commits
mailing list