aboutsummaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorTim Newsome <tim@sifive.com>2023-10-27 09:00:59 -0700
committerTim Newsome <tim@sifive.com>2023-10-27 09:00:59 -0700
commitf02fe0960cca39024afbb6edbf27490cee3afb1d (patch)
tree3427e34aa27e2340274f3d2855f697f70d492071 /HACKING
parent89260a5f1f76ef9490d602b004a862bd14681df5 (diff)
parent9f23a1d7c1e27c556ef9787b9d3f263f5c1ecf24 (diff)
downloadriscv-openocd-f02fe0960cca39024afbb6edbf27490cee3afb1d.zip
riscv-openocd-f02fe0960cca39024afbb6edbf27490cee3afb1d.tar.gz
riscv-openocd-f02fe0960cca39024afbb6edbf27490cee3afb1d.tar.bz2
Merge commit '9f23a1d7c1e27c556ef9787b9d3f263f5c1ecf24' into from_upstream
Conflicts: HACKING src/target/riscv/riscv-013.c Change-Id: I43ccb143cae8daa39212d66a8824ae3ad2af6fef
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING15
1 files changed, 15 insertions, 0 deletions
diff --git a/HACKING b/HACKING
index a2d4dcc..4935595 100644
--- a/HACKING
+++ b/HACKING
@@ -103,6 +103,21 @@ patch:
Now every time OpenOCD is run, coverage info in your build directory is
updated. Running `gcov src/path/file.c` will generate a report.
+- Sparse Static Analyzer
+
+ Using this tool allows identifying some bug in C code.
+ In the future, OpenOCD would use the sparse attribute 'bitwise' to
+ detect incorrect endianness assignments.
+
+ Example usage:
+ @code
+ mkdir build-sparse; cd build-sparse
+ ../configure CC=cgcc CFLAGS="-Wsparse-all -Wno-declaration-after-statement \
+ -Wno-unknown-attribute -Wno-transparent-union -Wno-tautological-compare \
+ -Wno-vla -Wno-flexible-array-array -D__FLT_EVAL_METHOD__=0"
+ make
+ @endcode
+
Please consider performing these additional checks where appropriate
(especially Clang Static Analyzer for big portions of new code) and
mention the results (e.g. "Valgrind-clean, no new Clang analyzer