diff options
| author | Andrei Karas <akaras@inbox.ru> | 2015-06-22 01:33:43 +0300 |
|---|---|---|
| committer | Andrei Karas <akaras@inbox.ru> | 2015-06-22 01:33:43 +0300 |
| commit | 680c792bd025ef52f8baca0189871e5d7e1e4e9f (patch) | |
| tree | 686af9d58d5d71a9b1ed30dac425f55e221a93ef /README.md | |
| parent | d0cfcf8643f6be08b4df9a9d351da4bdf910734f (diff) | |
| download | paranucker-680c792bd025ef52f8baca0189871e5d7e1e4e9f.tar.gz paranucker-680c792bd025ef52f8baca0189871e5d7e1e4e9f.tar.bz2 paranucker-680c792bd025ef52f8baca0189871e5d7e1e4e9f.tar.xz paranucker-680c792bd025ef52f8baca0189871e5d7e1e4e9f.zip | |
Add readme files.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..3e680da --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Ast Dumper - static code analyser for C/C++ + +This is gcc plugin for dump AST tree and search possible null pointers. + +Version 1.0 Date: 2015-06-22 + +## Build deps + - gcc 5 with plugin includes. (gcc-5-plugin) + For older gcc build possible, but need change make file. + - automake/autoconf. + +## Run time deps + - gcc 5 / g++ 5 or older. + +## Features + - Dump AST tree from gcc. + - Search missing basic null pointer checks for function input parameters. + - Dont check parameters with attribute [NONNULL](https://gcc.gnu.org/onlinedocs/gcc-5.1.0/gcc/Function-Attributes.html#index-g_t_0040code_007bnonnull_007d-function-attribute-3189). + - In future probably other checks... + +## Build + - Run build.sh + - You will get astdumper.so for gcc binary + and cppastdumper.so for g++ binary + +## Usage examples +In directory [examples] present two examples one for C++ and other for C. + + +Readme on russian [README.ru.md] |