From 51dbda54384827533dcfcb712f918cee7acc3185 Mon Sep 17 00:00:00 2001 From: Jake Merdich Date: Wed, 20 May 2020 12:17:55 -0400 Subject: [PATCH] [clang-format][docfix] Update predefined styles in docs Summary: The predefined styles that clang-format supports are listed in two places, and neither is up-to-date. GNU style isn't mentioned at all! Subscribers: cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D80309 --- clang/docs/ClangFormatStyleOptions.rst | 3 +++ clang/docs/LibFormat.rst | 22 +++++++++++++++++++++- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst index 2afa179..496e4c6 100644 --- a/clang/docs/ClangFormatStyleOptions.rst +++ b/clang/docs/ClangFormatStyleOptions.rst @@ -151,6 +151,9 @@ the configuration (without a prefix: ``Auto``). * ``Microsoft`` A style complying with `Microsoft's style guide `_ + * ``GNU`` + A style complying with the `GNU coding standards + `_ .. START_FORMAT_STYLE_OPTIONS diff --git a/clang/docs/LibFormat.rst b/clang/docs/LibFormat.rst index 889fbba..4ea84e6 100644 --- a/clang/docs/LibFormat.rst +++ b/clang/docs/LibFormat.rst @@ -40,7 +40,7 @@ Style Options The style options describe specific formatting options that can be used in order to make `ClangFormat` comply with different style guides. Currently, -two style guides are hard-coded: +several style guides are hard-coded: .. code-block:: c++ @@ -52,6 +52,26 @@ two style guides are hard-coded: /// http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml. FormatStyle getGoogleStyle(); + /// Returns a format style complying with Chromium's style guide: + /// https://chromium.googlesource.com/chromium/src/+/master/styleguide/styleguide.md + FormatStyle getChromiumStyle(); + + /// Returns a format style complying with the GNU coding standards: + /// https://www.gnu.org/prep/standards/standards.html + FormatStyle getGNUStyle(); + + /// Returns a format style complying with Mozilla's style guide + /// https://firefox-source-docs.mozilla.org/code-quality/coding-style/index.html + FormatStyle getMozillaStyle(); + + /// Returns a format style complying with Webkit's style guide: + /// https://webkit.org/code-style-guidelines/ + FormatStyle getWebkitStyle(); + + /// Returns a format style complying with Microsoft's style guide: + /// https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference + FormatStyle getMicrosoftStyle(); + These options are also exposed in the :doc:`standalone tools ` through the `-style` option. -- 2.7.4