[doc] Fix regex in ClangFormatStyleOptions for IncludeCategories

[jhuels]

Summary

This fixes the regex in ClangFormatStyleOptions for IncludeCategories to match anything starting with < or starting with | AND followed by (gtest|gmock|isl|json) then /.

[curdeius]

LGTM, but just to be clear: current regex matches everything starting with < or starting with " and followed by gtest|gmock|isl|json and followed by /. Please update the description when landing.

[MyDeveloperDay]

is the / before the /) at the end correct ?

vs

[curdeius]

In D115910#3199506, @MyDeveloperDay wrote:

is the / before the /) at the end correct ?

Yes, the regex tester you used needs escaping the slash as it uses sed-like expressions. But clang-format doesn't need escaping it.

[jhuels]

just to be clear: current regex matches everything starting with < or starting with " and followed by gtest|gmock|isl|json and followed by /.

Sorry, when I mean "current", I meant the current main branch. The main branch matches everything starting with < or " (which is everything).

My patch matches everything starting with < or " and followed by gtest|gmock|isl|json and followed by /.

[curdeius]

In D115910#3200135, @jhuels wrote:

just to be clear: current regex matches everything starting with < or starting with " and followed by gtest|gmock|isl|json and followed by /.

Sorry, when I mean "current", I meant the current main branch. The main branch matches everything starting with < or " (which is everything).

My patch matches everything starting with < or " and followed by gtest|gmock|isl|json and followed by /.

I did understand it this way. I just wanted to underline that, before this patch, it matched:

• < followed by anything,

or

• " followed by (gtest|gmock|isl|json)/

So it didn't match just " with whatever after.
Anyway, just nitpicking.
Your patch is good. Thanks!

[jhuels]

Can you commit for me, please? No push privs.

[jhuels]

So it didn't match just " with whatever after.

Ahh yes, you're right.

[HazardyKnusperkeks]

The change has to be done in the Format.h and then run dump_format_style.py, not directly in the rst.

Also please provide the context in the diff.

[jhuels]

Fixed the doc in the actual source, added context to diff.

[jhuels]

Sorry, I'm not sure why I'm getting "Context not available." I'm just copying raw output from git diff --staged

[jhuels]

Add context for real

[jhuels]

Got it, sorry for spam. Need git diff --staged -U999999.

[HazardyKnusperkeks]

In D115910#3200702, @jhuels wrote:

Got it, sorry for spam. Need git diff --staged -U999999.

No problem.

[owenpan]

clang/docs/ClangFormatStyleOptions.rst

3239

Why is there a trailing whitespace? Did you run dump_format_style.py to generate this file?

[jhuels]

clang/docs/ClangFormatStyleOptions.rst

3239

Yeah, I ran dump_format_style.py and didn't touch anything in the generated output. Someone must have added it on accident.

[jhuels]

Can someone with privileges push/merge this?

[owenpan]

In D115910#3201004, @jhuels wrote:

Can someone with privileges push/merge this?

What are the name and email address you want use for the author of the patch? See here.

[jhuels]

Joshua Huels <[e-mail]>

clang/docs/ClangFormatStyleOptions.rst

**IncludeCategories** (``List of IncludeCategories``) :versionbadge:`clang-format 7`
 
   .. code-block:: yaml
 
     IncludeCategories:
       - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
         Priority:        2
         SortPriority:    2
         CaseSensitive:   true
-      - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+      - Regex:           '^((<|")(gtest|gmock|isl|json)/)'
         Priority:        3
       - Regex:           '<[[:alnum:].]+>'
         Priority:        4
       - Regex:           '.*'
         Priority:        1
         SortPriority:    0
 
 **IncludeIsMainRegex** (``String``) :versionbadge:`clang-format 7`
.. code-block:: c++
 
       int * a;
 
 
 
 **QualifierAlignment** (``QualifierAlignmentStyle``) :versionbadge:`clang-format 14`
   Different ways to arrange specifiers and qualifiers (e.g. const/volatile).
 
-  .. warning::
+  .. warning:: 
 
    Setting ``QualifierAlignment``  to something other than `Leave`, COULD
    lead to incorrect code formatting due to incorrect decisions made due to
    clang-formats lack of complete semantic information.
    As such extra care should be taken to review code changes made by the use
    of this option.
 
   Possible values:

clang/include/clang/Tooling/Inclusions/IncludeStyle.h

struct IncludeStyle {
   ///
   /// To configure this in the .clang-format file, use:
   /// \code{.yaml}
   ///   IncludeCategories:
   ///     - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
   ///       Priority:        2
   ///       SortPriority:    2
   ///       CaseSensitive:   true
-  ///     - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+  ///     - Regex:           '^((<|")(gtest|gmock|isl|json)/)'
   ///       Priority:        3
   ///     - Regex:           '<[[:alnum:].]+>'
   ///       Priority:        4
   ///     - Regex:           '.*'
   ///       Priority:        1
   ///       SortPriority:    0
   /// \endcode
   /// \version 7