aboutsummaryrefslogtreecommitdiff
path: root/development/splint/README
diff options
context:
space:
mode:
Diffstat (limited to 'development/splint/README')
-rw-r--r--development/splint/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/development/splint/README b/development/splint/README
new file mode 100644
index 0000000000000..ff6b7c4a30c1a
--- /dev/null
+++ b/development/splint/README
@@ -0,0 +1,18 @@
+splint is a tool for statically checking C programs for security vulnerabilities
+and programming mistakes. Splint does many of the traditional lint checks
+including unused declarations, type inconsistencies, use before definition,
+unreachable code, ignored return values, execution paths with no return,
+likely infinite loops, and fall through cases.
+
+More powerful checks are made possible by additional information given
+in source code annotations. Annotations are stylized comments that
+document assumptions about functions, variables, parameters and types.
+In addition to the checks specifically enabled by annotations, many
+of the traditional lint checks are improved by exploiting this additional
+information.
+
+As more effort is put into annotating programs, better checking results.
+Splint is designed to be flexible and allow programmers to select
+appropriate points on the effort-benefit curve for particular projects.
+As different checks are turned on and more information is given in code
+annotations the number of bugs that can be detected increases dramatically.