Skip to content

Commit

Permalink
Sort compiler options out in README
Browse files Browse the repository at this point in the history
  • Loading branch information
danicheg committed Nov 29, 2023
1 parent 5f2a19a commit 254d4ec
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,23 +30,21 @@ Note that in Scala 2.13, the preferred form of the compiler option to enable sta

All the compiler plugin options are **prepended by `-P:scalac-profiling:`**.

* `show-profiles`: Show implicit searches and macro expansions by type and
call-site.
* `sourceroot`: Tell the plugin what is the source directory of the project.
Example: `-P:scalac-profiling:sourceroot:$PROJECT_BASE_DIR`.
* `print-search-result`: Print the result retrieved by an implicit search.
Example: `-P:scalac-profiling:print-search-result:$MACRO_ID`.
* `generate-macro-flamegraph`: Generate a flamegraph for macro expansions. The
flamegraph for implicit searches is enabled by default.
* `generate-global-flamegraph`: Creates a global flamegraph of implicit searches for all compilation units.
Use the `-P:scalac-profiling:sourceroot` option to manage the root directory,
otherwise, a working directory (defined by the `user.dir` property) will be picked.
* `print-failed-implicit-macro-candidates`: Print trees of all failed implicit
searches that triggered a macro expansion.
* `generate-macro-flamegraph`: Generate a flamegraph for macro expansions.
The flamegraph for implicit searches is enabled by default.
* `generate-profiledb`: Generate profiledb.
* `show-concrete-implicit-tparams`: Use more concrete type parameters in the
implicit search flamegraph. Note that it may change the shape of the
flamegraph.
* `print-failed-implicit-macro-candidates`: Print trees of all failed implicit searches that
triggered a macro expansion.
* `print-search-result`: Print the result retrieved by an implicit search.
Example: `-P:scalac-profiling:print-search-result:$MACRO_ID`.
* `show-concrete-implicit-tparams`: Use more concrete type parameters in the implicit search flamegraph.
Note that it may change the shape of the flamegraph.
* `show-profiles`: Show implicit searches and macro expansions by type and call-site.
* `sourceroot`: Tell the plugin what is the source directory of the project.
Example: `-P:scalac-profiling:sourceroot:$PROJECT_BASE_DIR`.

## Historical context

Expand Down

0 comments on commit 254d4ec

Please sign in to comment.