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

Reid Kleckner via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Mon Feb 28 10:20:54 PST 2022


rnk added a comment.

Thanks for writing docs, apologies for bikeshedding.



================
Comment at: clang/docs/ClangPlugins.rst:207
+
+If the main AST action is codegen, having any plugins that run after the
+codegen action automatically turns off ``-clear-ast-before-backend``.
----------------
I'd try to word this as a general recommendation that plugins should run before the main action, rather than documentation that running after the main action has undesired side effects (memory usage, settings).

A first sentence suggestion:
> To reduce peak memory usage of the compiler, plugins are recommended to run *before* the main action, which is usually code generation. This is because ... something ``-clear-ast-before-backend``


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D120666



More information about the cfe-commits mailing list