summaryrefslogtreecommitdiff
path: root/compilerplugins/README
diff options
context:
space:
mode:
authorLuboš Luňák <l.lunak@suse.cz>2013-02-09 18:47:55 +0100
committerLuboš Luňák <l.lunak@suse.cz>2013-02-09 18:48:31 +0100
commit857a39265452c23d4769e6d729ae4c30e44b2973 (patch)
tree6685ae0f84ab4638f9ab220c4a45d637e23ed83c /compilerplugins/README
parent8f1a01ad001d2288c4aa43420bb56bab1094aa20 (diff)
make it possible to limit what files will be modified by a compiler plugin
Change-Id: I4e3e8f5ca5e5b5b59b1bd067281f90940dd893b1
Diffstat (limited to 'compilerplugins/README')
-rw-r--r--compilerplugins/README11
1 files changed, 9 insertions, 2 deletions
diff --git a/compilerplugins/README b/compilerplugins/README
index 52e34b9d49d8..a9881c7f3599 100644
--- a/compilerplugins/README
+++ b/compilerplugins/README
@@ -35,8 +35,15 @@ All warnings and errors are marked '[loplugin]' in the message.
Rewriters analyse and possibly modify given source files.
Usage: make COMPILER_PLUGIN_TOOL=<rewriter_name>
-It is possible to also pass FORCE_COMPILE_ALL=1 to make to trigger rebuild of all source files,
-even those that are up to date.
+Additional optional make arguments:
+- it is possible to also pass FORCE_COMPILE_ALL=1 to make to trigger rebuild of all source files,
+ even those that are up to date.
+- UPDATE_FILES=<scope> - limits which modified files will be actually written back with the changes
+ - mainfile - only the main .cxx file will be modifed (default)
+ - all - all source files involved will be modified (possibly even header files from other LO modules),
+ 3rd party header files are however never modified
+ - <module> - only files in the given LO module (toplevel directory) will be modified (including headers)
+
Modifications will be written directly to the source files.