Update README to mention how to set a GC plan #219
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
caizixian
reviewed
Oct 16, 2023
README.md
Outdated
| @@ -209,6 +209,10 @@ $ VO_BIT=1 make CONF=linux-x86_64-normal-server-$DEBUG_LEVEL THIRD_PARTY_HEAP=$P | |||
|
|
|||
| ## Test | |||
|
|
|||
| 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`. | |||
There was a problem hiding this comment.
Maybe we should mention how to find out the plan available by linking to mmtk-core code?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
I added a link to https://docs.mmtk.io/api/mmtk/util/options/enum.PlanSelector.html.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates README about how to explicitly selecting an MMTk plan.