Author: djasper
Date: Mon Oct 5 02:24:55 2015
New Revision: 249289
URL: http://llvm.org/viewvc/llvm-project?rev=249289&view=rev
Log:
clang-format: Document threshold for adding new options.
Modified:
cfe/trunk/docs/ClangFormatStyleOptions.rst
Modified: cfe/trunk/docs/ClangFormatStyleOptions.rst
URL:
http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/ClangFormatStyleOptions.rst?rev=249289&r1=249288&r2=249289&view=diff
==============================================================================
--- cfe/trunk/docs/ClangFormatStyleOptions.rst (original)
+++ cfe/trunk/docs/ClangFormatStyleOptions.rst Mon Oct 5 02:24:55 2015
@@ -586,6 +586,28 @@ the configuration (without a prefix: ``A
.. END_FORMAT_STYLE_OPTIONS
+Adding additional style options
+===============================
+
+Each additional style option adds costs to the clang-format project. Some of
+these costs affect the clang-format developement itself, as we need to make
+sure that any given combination of options work and that new features don't
+break any of the existing options in any way. There are also costs for end
users
+as options become less discoverable and people have to think about and make a
+decision on options they don't really care about.
+
+The goal of the clang-format project is more on the side of supporting a
+limited set of styles really well as opposed to supporting every single style
+used by a codebase somewhere in the wild. Of course, we do want to support all
+major projects and thus have established the following bar for adding style
+options. Each new style option must ..
+
+ * .. be used in a project of significant size (have dozens of contributors)
+ * .. have a publicly accessible style guide
+ * .. have a person willing to contribute and maintain patches
+
+At least two out of these three need to be met.
+
Examples
========
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
