From e8058034a37d46f296d8b0366e74dd61ccd14dc5 Mon Sep 17 00:00:00 2001 From: Ryan Pavlik Date: Thu, 11 Feb 2021 09:45:58 -0600 Subject: [PATCH] readme: Clarify clang-format usage/version --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b9cc6765..0e849669b 100644 --- a/README.md +++ b/README.md @@ -241,8 +241,11 @@ scripts/format-project.sh You can optionally put something like `CLANG_FORMAT=clang-format-7` before that command if your clang-format binary isn't named `clang-format`. -Note that you'll typically prefer to use something like `git clang-format` +**Note that you'll typically prefer** to use something like `git clang-format` to just re-format your changes, in case version differences in tools result in overall format changes. +The CI "style" job currently runs on Debian Buster, so it has clang-format-7. +We will probably update that job to Bullseye or Ubuntu 20.10, which will allow +using clang-format-11 by default, soon. [OpenHMD]: http://openhmd.net [drm-lease]: https://haagch.frickel.club/#!drmlease%2Emd