summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndrei Karas <akaras@inbox.ru>2015-06-22 02:04:19 +0300
committerAndrei Karas <akaras@inbox.ru>2015-06-22 02:04:19 +0300
commit956c0a882c30af6e3f08acbf3fa31587f1bdafab (patch)
treeaf29ab83f8eed935d60c22b982363627acac1145 /README.md
parent1e5b7eb1d65f680cf1efbc340c5b81a43e5e00d3 (diff)
downloadparanucker-956c0a882c30af6e3f08acbf3fa31587f1bdafab.tar.gz
paranucker-956c0a882c30af6e3f08acbf3fa31587f1bdafab.tar.bz2
paranucker-956c0a882c30af6e3f08acbf3fa31587f1bdafab.tar.xz
paranucker-956c0a882c30af6e3f08acbf3fa31587f1bdafab.zip
Add advanced usage into readmes.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index b5a263d..ee2c00a 100644
--- a/README.md
+++ b/README.md
@@ -30,4 +30,22 @@ In directory [examples](examples) present two examples one for C++ and other for
- [ManaPlus](http://manaplus.org/)
- [Hercules](http://herc.ws/)
+## Advanced usage
+Ast Dumper support one plugin paramater named -fplugin-arg-astdumper-command or -fplugin-arg-cppastdumper-command depend what you using C or C++
+
+Example:
+ gcc-5 -fplugin=../astdumper.so -fplugin-arg-astdumper-command=detectnullpointers
+
+Known parameter values:
+ | name | action |
+ | ------------------ | ----------------------------------------------------- |
+ | parse | silently parse AST |
+ | dump | dump whole AST |
+ | smalldump | small AST dump without indention |
+ | memoryusage | show how many nodes parsed |
+ | dumpunsupported | dump nodes what cant be parsed |
+ | findargs | dump functions and argument names what can be checked |
+ | detectnullpointers | search null pointers |
+ | dumpnullpointers | search null pointers and dump some debug info |
+
Readme on russian [README.ru.md](README.ru.md)