[PATCH] D120666: [docs] Add note about interaction between clang plugins and -clear-ast-before-backend

[Arthur Eubanks via Phabricator via cfe-commits]

aeubanks updated this revision to Diff 411829.
aeubanks added a comment.

reword


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D120666/new/

https://reviews.llvm.org/D120666

Files:
  clang/docs/ClangPlugins.rst


Index: clang/docs/ClangPlugins.rst
===================================================================
--- clang/docs/ClangPlugins.rst
+++ clang/docs/ClangPlugins.rst
@@ -200,3 +200,14 @@
   PluginASTAction::ActionType getActionType() override {
     return AddAfterMainAction;
   }
+
+Interaction with ``-clear-ast-before-backend``
+----------------------------------------------
+
+If the main AST action is codegen, having any plugins that run after the
+codegen action automatically turns off ``-clear-ast-before-backend``.
+``-clear-ast-before-backend`` reduces peak memory by clearing the Clang AST 
after
+generating IR and before running IR optimizations. Use
+``CmdlineBeforeMainAction`` or ``AddBeforeMainAction`` as ``getActionType`` to
+run plugins before the codegen action and still have access to peak memory
+savings from ``-clear-ast-before-backend``.



Index: clang/docs/ClangPlugins.rst
===================================================================
--- clang/docs/ClangPlugins.rst
+++ clang/docs/ClangPlugins.rst
@@ -200,3 +200,14 @@
   PluginASTAction::ActionType getActionType() override {
     return AddAfterMainAction;
   }
+
+Interaction with ``-clear-ast-before-backend``
+----------------------------------------------
+
+If the main AST action is codegen, having any plugins that run after the
+codegen action automatically turns off ``-clear-ast-before-backend``.
+``-clear-ast-before-backend`` reduces peak memory by clearing the Clang AST after
+generating IR and before running IR optimizations. Use
+``CmdlineBeforeMainAction`` or ``AddBeforeMainAction`` as ``getActionType`` to
+run plugins before the codegen action and still have access to peak memory
+savings from ``-clear-ast-before-backend``.

_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits