From: James Zern <jzern@google.com>
Date: Thu, 28 Jul 2016 05:16:51 +0000 (-0700)
Subject: README: add a note about clang-format
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=92ed0c9146cbd7eda7c7e60c889b1eda494b6445;p=libvpx

README: add a note about clang-format

Change-Id: I835401e3befffcbc68e7d2bdd2fd556a19948e91
(cherry picked from commit 15f29ef0922c6584dea69ac75367edb2f6934bb3)
---

diff --git a/README b/README
index 460ad7390..0f95a8f45 100644
--- a/README
+++ b/README
@@ -127,6 +127,21 @@ VP8/VP9 TEST VECTORS:
   $ ./configure --enable-unit-tests
   $ LIBVPX_TEST_DATA_PATH=../libvpx-test-data make testdata
 
+CODE STYLE:
+  The coding style used by this project is enforced with clang-format using the
+  configuration contained in the .clang-format file in the root of the
+  repository.
+
+  Before pushing changes for review you can format your code with:
+  # Apply clang-format to modified .c, .h and .cc files
+  $ clang-format -i --style=file \
+    $(git diff --name-only --diff-filter=ACMR '*.[hc]' '*.cc')
+
+  Check the .clang-format file for the version used to generate it if there is
+  any difference between your local formatting and the review system.
+
+  See also: http://clang.llvm.org/docs/ClangFormat.html
+
 SUPPORT
   This library is an open source project supported by its community. Please
   please email webm-discuss@webmproject.org for help.