Page MenuHomePhabricator

Updates to the 'CLion Integration' section in ClangFormat docs
ClosedPublic

Authored by MarinaKalashina on May 28 2020, 6:51 AM.

Details

Summary

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.

Diff Detail

Repository
rC Clang

Event Timeline

@sammccall, @klimek, @gribozavr2, @MyDeveloperDay who would be the best reviewer for this?
Could do the reviews myself for small CLion-related documentation changes if everyone is ok with this. Does that LG?

clang/docs/ClangFormat.rst
178–179

NIT: lines are now longer than before, could you wrap the text in accordance with the code style?

179–186

NIT: we should probably use :program:'clang-format' (with backticks instead of ', couldn't figure out how to escape them in markdown), for consistency with the rest of the document.

linewidth corrected; "Clang-Format" changed to ":program:clang-format"

klimek added a comment.Jun 8 2020, 7:52 AM

@sammccall, @klimek, @gribozavr2, @MyDeveloperDay who would be the best reviewer for this?
Could do the reviews myself for small CLion-related documentation changes if everyone is ok with this. Does that LG?

I think that's makes lots of sense, as I think none of us are in a very good position to review those (I'd personally just LG them :)
Thanks!

This revision is now accepted and ready to land.Jun 8 2020, 8:59 AM

Added a few minor changes before committing:

  • surround names of .clang-format files with double backticks
  • ensure no lines are longer than 80 characters
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptJun 8 2020, 9:57 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript