mirrors/llvm-project
0
0
Fork 0
mirror of https://github.com/llvm/llvm-project.git synced 2025-04-29 08:46:06 +00:00
Code Issues Projects Releases Wiki Activity

Updates to the 'CLion Integration' section in ClangFormat docs

Browse Source 
This commit updates the 'CLion Integration' section in ClangFormat docs.
Key changes:
- clang-format is enabled automatically when there is a config file;
- formatting now works for indentations;
- if clang-format is enabled without a config file, CLion suggests creating it based on the IDE settings or uses the LLVM style by default.

Patch by Marina Kalashina!

Reviewers: sylvestre.ledru, ilya-biryukov

Reviewed By: ilya-biryukov

Subscribers: ilya-biryukov, klimek, MyDeveloperDay, sammccall, gribozavr2

Differential Revision: https://reviews.llvm.org/D80721
This commit is contained in:
Ilya Biryukov 2020-06-08 19:20:10 +03:00
parent 8744d7f25b
commit 9982d48a92
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
clang/docs/ClangFormat.rst
View File

@ -176,13 +176,14 @@ CLion Integration
=================
:program:`clang-format` is integrated into `CLion <https://www.jetbrains
.com/clion/>`_ as an alternative code formatter. It is disabled by default and
can be turned on in Settings/Preferences | Editor | Code Style.
.com/clion/>`_ as an alternative code formatter. CLion turns it on
automatically when there is a ``.clang-format`` file under the project root.
Code style rules are applied as you type, including indentation,
auto-completion, code generation, and refactorings.
If :program:`clang-format` support is enabled, CLion detects config files when
opening a project and suggests overriding the current IDE settings. Code style
rules from the ``.clang-format`` files are then applied automatically to all
editor actions, including auto-completion, code generation, and refactorings.
:program:`clang-format` can also be enabled without a ``.clang-format`` file.
In this case, CLion prompts you to create one based on the current IDE settings
or the default LLVM style.
Visual Studio Integration