This is an automated email from the ASF dual-hosted git repository.
wesm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new db83fb4 [C++] Update README for linting (#1515)
db83fb4 is described below
commit db83fb400d932782ebb32a93582f8ab9cbd1130b
Author: Antoine Pitrou <[email protected]>
AuthorDate: Thu Jan 25 17:07:17 2018 +0100
[C++] Update README for linting (#1515)
* [C++] Update README for linting
There are hidden gotchas when trying to move the linting Makefile targets,
mention them.
* Mention the LLVM releases page
---
cpp/README.md | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/cpp/README.md b/cpp/README.md
index d2262a6..b063248 100644
--- a/cpp/README.md
+++ b/cpp/README.md
@@ -252,6 +252,24 @@ Logging IWYU to /tmp/arrow-cpp-iwyu.gT7XXV
...
```
+### Linting
+
+We require that you follow a certain coding style in the C++ code base.
+You can check your code abides by that coding style by running:
+
+ make lint
+
+You can also fix any formatting errors automatically:
+
+ make format
+
+These commands require `clang-format-4.0` (and not any other version).
+You may find the required packages at http://releases.llvm.org/download.html
+or use the Debian/Ubuntu APT repositories on https://apt.llvm.org/.
+
+Also, if under a Python 3 environment, you need to install a compatible
+version of `cpplint` using `pip install cpplint`.
+
## Continuous Integration
Pull requests are run through travis-ci for continuous integration. You can
avoid
--
To stop receiving notification emails like this one, please contact
[email protected].
