diff options
author | Luboš Luňák <l.lunak@suse.cz> | 2012-10-05 18:17:13 +0200 |
---|---|---|
committer | Luboš Luňák <l.lunak@suse.cz> | 2012-10-09 17:25:27 +0200 |
commit | 02a8d36ebf3d54784903f2899eafe010bedf2f4c (patch) | |
tree | 61ba648242b1356b7da72336073b91e397814e50 /compilerplugins/README | |
parent | 7b34748b1bfd8b5fe0406c1f6bdaaa585d7bc4c3 (diff) |
initial support for clang compiler plugins
The plugin is intentionally built using a custom Makefile,
because it's used by gbuild, so I don't want to build the plugin
using gbuild too. It is also intentionally not placed under workdir/,
as that is cleaned by 'make clean', the plugin is cleaned only
by 'make distclean', so that cleaning it doesn't cause ccache misses.
No actual functionality in the plugin itself yet.
Change-Id: Ic05eba8d6260eec123c9e699eb5385abfe1b832f
Diffstat (limited to 'compilerplugins/README')
-rw-r--r-- | compilerplugins/README | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/compilerplugins/README b/compilerplugins/README new file mode 100644 index 000000000000..98ac70c85ef5 --- /dev/null +++ b/compilerplugins/README @@ -0,0 +1,27 @@ +Compiler plugins. + +== Overview == + +This directory contains code for compiler plugins. These are used to perform +additional actions during compilation (such as additional warnings) and +also to perform mass code refactoring. + +Currently only the Clang compiler is supported (http://clang.llvm.org). + +== Usage == + +Compiler plugins are enabled automatically by --enable-dbgutil if Clang headers +are found or explicitly using --enable-compiler-plugins. + + +== Functionality == + +=== Compile plugin === + +The compile plugin is used during normal compilation to perform additional checks. +All warnings and errors are marked '[loplugin]' in the message. + + +== Code documentation / howtos == + +TBD |