Skip to content

Commit d082399

Browse files
committed
CODING_STANDARD.md: fix references to clang-format
This fixes the description of how to use clang-format in CODING_STANDARD.md. * The CI uses clang-format-11 (as opposed to -10) since 557d941. * The promise that this is available on Ubuntu 18.04 cannot be met. The earliest version of Ubuntu that has clang-format-11 out of the box is 20.04. * There is a reference to COMPILING.md, which does not say anything at all about clang-format.
1 parent cb62568 commit d082399

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

CODING_STANDARD.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ Here a few minimalistic coding rules for the CPROVER source tree.
1212

1313
# Whitespaces
1414

15-
Formatting is enforced using clang-format. For more information about this, see
16-
`COMPILING.md`. A brief summary of the formatting rules is given below:
15+
Formatting is enforced using clang-format. For more information about this,
16+
see the section "using clang-format" below. A brief summary of the
17+
formatting rules is given below:
1718

1819
- Use 2 spaces indent, no tabs.
1920
- No lines wider than 80 chars.
@@ -340,13 +341,13 @@ To avoid waiting until you've made a PR to find formatting issues, you can
340341
install clang-format locally and run it against your code as you are working.
341342

342343
Different versions of clang-format have slightly different behaviors. CBMC uses
343-
clang-format-10 as it is available the repositories for Ubuntu 18.04 and
344+
clang-format-11 as it is available the repositories for Ubuntu 20.04 and
344345
Homebrew.
345346
To install on a Unix-like system, try installing using the system package
346347
manager:
347348
```
348-
apt-get install clang-format-10 # Run this on Ubuntu, Debian etc.
349-
brew install clang-format@10 # Run this on a Mac with Homebrew installed
349+
apt-get install clang-format-11 # Run this on Ubuntu, Debian etc.
350+
brew install clang-format@11 # Run this on a Mac with Homebrew installed
350351
```
351352

352353
If your platform doesn't have a package for clang-format, you can download a
@@ -373,7 +374,7 @@ rebase your work onto the tip of the branch it's based on before running
373374
Note: By default, git-clang-format uses the git config variable
374375
`clangformat.binary`. If you have multiple versions of clang-format installed,
375376
you might need to update this, or explicitly specify the binary to use via
376-
`--binary clang-format-10`.
377+
`--binary clang-format-11`.
377378

378379
### RETROACTIVELY FORMATTING INDIVIDUAL COMMITS
379380

0 commit comments

Comments
 (0)