runformat: improve instructions [ci skip] (#5833)
This commit is contained in:
parent
1eee68f039
commit
fc1d4d6f7d
12
runformat
12
runformat
|
@ -1,9 +1,15 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
#
|
#
|
||||||
# uncrustify-0.72 is used to format cppcheck source code.
|
# uncrustify-0.72 is used to format cppcheck source code.
|
||||||
# source code: https://github.com/uncrustify/uncrustify/archive/refs/tags/uncrustify-0.72.0.zip
|
#
|
||||||
# building in Linux: mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Release .. && make
|
# 1. Download source code: https://github.com/uncrustify/uncrustify/archive/refs/tags/uncrustify-0.72.0.zip
|
||||||
# building in Windows: mkdir build && cd build && cmake -G"NMake Makefiles" -DCMAKE_BUILD_TYPE=Release .. && nmake
|
# It's important that all Cppcheck developers use the exact same version so we don't get a "format battle".
|
||||||
|
# 2. Building:
|
||||||
|
# - Linux: mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Release .. && make
|
||||||
|
# - Windows: mkdir build && cd build && cmake -G"NMake Makefiles" -DCMAKE_BUILD_TYPE=Release .. && nmake
|
||||||
|
# 3. Ensure that the binary "uncrustify" is found by runformat. Either:
|
||||||
|
# - you can put uncrustify in your PATH
|
||||||
|
# - you can create an environment variable UNCRUSTIFY that has the full path of the binary
|
||||||
|
|
||||||
UNCRUSTIFY_VERSION="0.72.0"
|
UNCRUSTIFY_VERSION="0.72.0"
|
||||||
UNCRUSTIFY="${UNCRUSTIFY-uncrustify}"
|
UNCRUSTIFY="${UNCRUSTIFY-uncrustify}"
|
||||||
|
|
Loading…
Reference in New Issue