Skip to content

Commit 2a18171

Browse files
committed
chore(runformat): Fix expected uncrustify version and update instructions
Set version 0.80.1 to match the one from cppcheck-opensource/cppcheck@3726ace5d
1 parent a2c7556 commit 2a18171

1 file changed

Lines changed: 14 additions & 11 deletions

File tree

runformat

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
#!/bin/bash
22
#
3-
# uncrustify-0.72 is used to format simplecpp and cppcheck source code.
3+
# runformat - format this project's C++ sources with Uncrustify.
4+
#
5+
# Usage:
6+
# ./runformat # format using the configured Uncrustify
7+
#
8+
# Requirements:
9+
# - All developers must use the *exact* same Uncrustify version to avoid format churn.
10+
# - Either:
11+
# * Have `uncrustify` in PATH, or
12+
# * Set env var UNCRUSTIFY=/absolute/path/to/uncrustify
13+
#
14+
# Notes:
15+
# - The config file is expected at: ./.uncrustify.cfg
416
#
5-
# 1. Download source code: https://github.com/uncrustify/uncrustify/archive/refs/tags/uncrustify-0.72.0.zip
6-
# It's important that all developers use the exact same version so we don't get a "format battle".
7-
# 2. Building:
8-
# - Linux: mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Release .. && make
9-
# - Windows: mkdir build && cd build && cmake -G"NMake Makefiles" -DCMAKE_BUILD_TYPE=Release .. && nmake
10-
# 3. Ensure that the binary "uncrustify" is found by runformat. Either:
11-
# - you can put uncrustify in your PATH
12-
# - you can create an environment variable UNCRUSTIFY that has the full path of the binary
13-
1417
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
1518
cd "$SCRIPT_DIR"
1619

17-
UNCRUSTIFY_VERSION="0.72.0"
20+
UNCRUSTIFY_VERSION="0.80.1"
1821
UNCRUSTIFY="${UNCRUSTIFY-uncrustify}"
1922

2023
err() { echo -e >&2 "ERROR: $@\n"; }

0 commit comments

Comments
 (0)