Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How do we want to document clang-tidy and clang-format config options? #126

Open
sssoleileraaa opened this issue Apr 27, 2018 · 2 comments

Comments

@sssoleileraaa
Copy link

Would it be useful to add documentation in the config files about different clang-tidy options for example? Or would we rather document in a readme?

@springmeyer
Copy link
Contributor

👍 let's document more in the .clang-tidy and .clang-format themselves (since this will travel with them). Then in the docs we can link to the configs for more detail. Sound good?

Other todo we had:

  • Clean up the configs so that they only include stuff we understand

@sssoleileraaa sssoleileraaa changed the title How document clang-tidy and clang-format config files How do we want to document clang-tidy and clang-format config options? May 1, 2018
@sssoleileraaa
Copy link
Author

sssoleileraaa commented May 1, 2018

I like it! Instead of, for example:

AnalyzeTemporaryDtors: false
CheckOptions:   
  - key:             modernize-use-nullptr.NullMacros
    value:           'NULL'

we would have something like:

# AnalyzeTemporaryDtors is set to false because...
AnalyzeTemporaryDtors: false
CheckOptions:   
  # this check converts the usage of null pointer `NULL` constants to use the new C++11 nullptr keyword
  - key:             modernize-use-nullptr.NullMacros
    value:           'NULL'

I'd be happy to make this change in a PR so you can double-check my understanding of what each of these settings are doing. Also during this process we will be able to mark Clean up the configs so that they only include stuff we understand as done because everything in our config files will be documented and understood.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants