Skip to content

Update README to mention how to set a GC plan#219

Open
qinsoon wants to merge 3 commits intommtk:masterfrom
qinsoon:choose-plan-in-readme
Open

Update README to mention how to set a GC plan#219
qinsoon wants to merge 3 commits intommtk:masterfrom
qinsoon:choose-plan-in-readme

Conversation

@qinsoon
Copy link
Copy Markdown
Member

@qinsoon qinsoon commented May 17, 2023

This PR updates README about how to explicitly selecting an MMTk plan.

@qinsoon qinsoon marked this pull request as ready for review October 16, 2023 03:14
@qinsoon qinsoon requested a review from caizixian October 16, 2023 03:14
Comment thread README.md Outdated

We support most MMTk GC plans in OpenJDK, such as `SemiSpace`, `Immix`, `GenImmix`, `StickyImmix`, `GenCopy`, `MarkCompact`, `MarkSweep`, `PageProtect`, and `NoGC`.
When you run with the OpenJDK build from previous steps, you can choose one of the plans by setting an environment variable `MMTK_PLAN`. In the following examples, we use
the generational immix plan, `GenImmix`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should mention how to find out the plan available by linking to mmtk-core code?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can expose some information via, for example, java --version or -XX:ShowMmtkPlans, by printing out all plans supported by the OpenJDK binding, and/or all available plans in mmtk-core.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants