microsoft / microsoft/gctoolkit
Document recommended flags for GCToolkit
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.3k
- Forks
- 177
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 3
Description
OK, thank you, that makes sense and quite a few of the Garbage Collection tools document the subset of flags that they support. I tried again with the ones you suggested and it worked (although the Maven VM never exited, not sure if that's intentional and whether it "tails" the file?)
Are these "recommended" flags documented somewhere that I missed? Or should they be added? Maybe to the README for the samples to show what do use when one generates the file?
In future it would be great if one could pass the toolkit the flags that were used and it would then be able to handle pretty much any format as long as it's told what the format is.
Originally posted by @massdosage in https://github.com/microsoft/gctoolkit/issues/209#issuecomment-1046738783
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by checking the README and sample documentation for GCToolkit, especially the guidance around generating GC log files and the recommended flags. Document the supported or recommended flags and show how they should be used with the samples; done means a user can find this guidance without searching issue discussions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100