[clang-format][doc] Fix contradiction in SortIncludes description
authorMike Matthews <michael.g.matthews3@gmail.com>
Fri, 26 May 2023 08:53:25 +0000 (01:53 -0700)
committerOwen Pan <owenpiano@gmail.com>
Fri, 26 May 2023 08:58:57 +0000 (01:58 -0700)
Fixes #62033.

Differential Revision: https://reviews.llvm.org/D147894

clang/docs/ClangFormatStyleOptions.rst
clang/include/clang/Format/Format.h

index 56b6b62..a8fc651 100644 (file)
@@ -2453,7 +2453,7 @@ the configuration (without a prefix: ``Auto``).
   * ``BBCDS_Allowed`` (in configuration: ``Allowed``)
     Breaking between template declaration and ``concept`` is allowed. The
     actual behavior depends on the content and line breaking rules and
-    penalties.
+    penalities.
 
   * ``BBCDS_Always`` (in configuration: ``Always``)
     Always break before ``concept``, putting it in the line after the
@@ -4561,11 +4561,6 @@ the configuration (without a prefix: ``Auto``).
 
 **SortIncludes** (``SortIncludesOptions``) :versionbadge:`clang-format 3.8` :ref:`ΒΆ <SortIncludes>`
   Controls if and how clang-format will sort ``#includes``.
-  If ``Never``, includes are never sorted.
-  If ``CaseInsensitive``, includes are sorted in an ASCIIbetical or case
-  insensitive fashion.
-  If ``CaseSensitive``, includes are sorted in an alphabetical or case
-  sensitive fashion.
 
   Possible values:
 
index 1cc1037..78c0847 100644 (file)
@@ -3601,11 +3601,6 @@ struct FormatStyle {
   };
 
   /// Controls if and how clang-format will sort ``#includes``.
-  /// If ``Never``, includes are never sorted.
-  /// If ``CaseInsensitive``, includes are sorted in an ASCIIbetical or case
-  /// insensitive fashion.
-  /// If ``CaseSensitive``, includes are sorted in an alphabetical or case
-  /// sensitive fashion.
   /// \version 3.8
   SortIncludesOptions SortIncludes;