summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJames Zern <jzern@google.com>2016-07-27 22:16:51 -0700
committerJames Zern <jzern@google.com>2016-08-03 17:34:03 -0700
commit15f29ef0922c6584dea69ac75367edb2f6934bb3 (patch)
tree9f21deb283fabb0f0c61ec2951a696097e0814a8 /README
parent77f5c3d2e8416ca4af81eadbf9a2a0d59e463eaa (diff)
downloadlibvpx-15f29ef0922c6584dea69ac75367edb2f6934bb3.tar
libvpx-15f29ef0922c6584dea69ac75367edb2f6934bb3.tar.gz
libvpx-15f29ef0922c6584dea69ac75367edb2f6934bb3.tar.bz2
libvpx-15f29ef0922c6584dea69ac75367edb2f6934bb3.zip
README: add a note about clang-format
Change-Id: I835401e3befffcbc68e7d2bdd2fd556a19948e91
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 15 insertions, 0 deletions
diff --git a/README b/README
index 774109026..24e8f7dbc 100644
--- a/README
+++ b/README
@@ -131,6 +131,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
email webm-discuss@webmproject.org for help.