From: Lyndon Nerenberg <lyndon@orthanc.ca>
Date: Wed, 7 May 2014 19:07:03 +0000 (-0700)
Subject: Add a 'tools' subdirectory.  This is a home for developer-oriented
X-Git-Url: https://diplodocus.org/git/nmh/commitdiff_plain/6aad84f473222fd24069baf9b28e9b31ebf9fe49?hp=6cce62edaae4cc28ac42a1a796ff18f183407788

Add a 'tools' subdirectory.  This is a home for developer-oriented
scripts and such which can't be run from the Makefile(s) due to
system dependencies.
---

diff --git a/tools/README b/tools/README
new file mode 100644
index 00000000..b5b20f4b
--- /dev/null
+++ b/tools/README
@@ -0,0 +1,12 @@
+This directory contains tools, scripts, and supporting files used
+by the developers while writing, debugging, and testing the code.
+By definition, anything in this directory is not portable.  The
+files can (and probably do) depends on specific programs being
+installed, might only run on a specific operating system release,
+or have dependacies on the ritual sacrifice of politicians.
+
+In the interest of consistency, scripts or programs placed here
+should be written to be invoked from the top-level nmh source code
+directory.  E.g., 'tools/csa' should do the right thing when run
+from this directory's parent.  If that's not possible, please add
+a note here or in the relevant script saying how to run things.
diff --git a/tools/csa b/tools/csa
new file mode 100755
index 00000000..f2f91bf1
--- /dev/null
+++ b/tools/csa
@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# Run the clang static analyzer across the code base.
+# The '--user-analyzer /usr/bin/clang' is here to work around a bug
+# in the version of CSA for MacOS.  It runs the wrong clang binary, otherwise.
+#
+# Note: you must run configure before running this script.
+
+echo cleaning ...; make clean >/dev/null 2>&1
+scan-build -V -v -stats -maxloop 10 --use-analyzer /usr/bin/clang -o /tmp/nmh make