Index: c++/clang-format/README.md |
=================================================================== |
new file mode 100644 |
--- /dev/null |
+++ b/c++/clang-format/README.md |
@@ -0,0 +1,27 @@ |
+clang-format-eyeo |
+================= |
+ |
+A file containing style configuration for [`clang-format`](http://clang.llvm.org/docs/ClangFormat.html) |
+that formats according to the [Adblock Plus coding style guide](https://adblockplus.org/coding-style#cpp) |
+for C++. |
+ |
+Installation |
+------------ |
+ |
+When `clang-format` receives its style configuration from a file, it searches |
+for style configuration in the directory of each input file and then each parent |
+directory. Copy the format file to the parent directory of the working |
+directory. In this way it will `clang-format` will find the format file and |
+the version control system will not. |
+ |
+The configuration file must be named either "`.clang-format`" or "`_clang-format`". |
+At the present time there's no command line option to specify the file name. |
+ |
+Usage |
+----- |
+ |
+ clang-format -style=file [...] |
+ |
+The option "-style=file" (note that this is the word "file", not a file name) |
+says to perform a directory search for the configuration. For the rest of the |
+command line, see the `clang-format` documentation link above. |