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

Activity

1. springmeyer commented on Apr 30, 2018

   

   springmeyer

   on Apr 30, 2018

   Contributor

   More actions

   👍 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

   👍React with 👍1Reacted by sssoleileraaa
2. 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?[/+] on May 1, 2018
3. sssoleileraaa commented on May 1, 2018

   

   sssoleileraaa

   on May 1, 2018

   Last edited by sssoleileraaa

   Author

   More actions

   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.