Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added information about what a Gen X column means #1175

Merged
merged 4 commits into from Jul 15, 2019

Conversation

jigargandhi
Copy link
Contributor

Added information about what a Gen X means. Right now the definition is ambiguous of whether it is the number of objects in that generation or the number of collections in that generation

Added information about what a Gen X means. Right now the definition is ambiguous of whether it is the number of objects in that generation or the number of collections in that generation
@AndreyAkinshin
Copy link
Member

Hey @jigargandhi! Thanks for the PR.
Indeed, it makes sense to add extra information about "Gen X" columns in the documentation. However, the new sentence is not completely correct. We should remove the "to clean up memory" part because a GC collection doesn't always clean up memory. This column shows the number of GC Generation collects per 1000 operations. We print this information below the summary table in the legend section:

Legend = $"GC Generation {generationId} collects per 1000 operations";

@AndreyAkinshin
Copy link
Member

Hey @jigargandhi! Would you like to update your PR?

@jigargandhi
Copy link
Contributor Author

jigargandhi commented Jul 13, 2019 via email

Removed the text "to clean up memory" as GC generation may not clean up memory
@AndreyAkinshin
Copy link
Member

@jigargandhi the new version is still not correct. This column displays the number of collections per 1000 operations.

Missed adding per 1000 operations
@AndreyAkinshin
Copy link
Member

Also, the current sentence doesn't have a mention of GC (the corresponding line in the legend has this information: "GC Generation {generationId} collects per 1000 operations"); a period at the end of the sentence is missing.

Added GC collections to the statement
@AndreyAkinshin AndreyAkinshin merged commit 863c651 into dotnet:master Jul 15, 2019
@AndreyAkinshin
Copy link
Member

@jigargandhi thanks!

@AndreyAkinshin AndreyAkinshin added this to the v0.11.6 milestone Jul 15, 2019
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.

None yet

2 participants