add README

1 files changed, 16 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..0cd9087
--- /dev/null
+++ b/README
@@ -0,0 +1,16 @@
+You'll need "spatch", from coccinelle.
+
+You can install this on Fedora using:
+   yum install coccinelle
+
+To run, invoke this:
+   spatch -sp_file pyarg-parsetuple.cocci buggy.c 
+
+This gives this output:
+
+[david@brick static-analysis]$ spatch -sp_file pyarg-parsetuple.cocci buggy.c
+init_defs_builtins: /usr/share/coccinelle/standard.h
+HANDLING: buggy.c
+buggy.c:13: Mismatching type of argument 1: expected "int *" but got "unsigned long *"
+
+which correctly detects an issue seen in socket.htons() on 64bit big endian machines
\ No newline at end of file