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.

Sign up for GitHub

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

Clarify memory load #6868

Merged
merged 2 commits into from
Jul 7, 2021
Merged

Clarify memory load #6868

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dbefef0
Clarify memory load
gewarren Jul 7, 2021
0af6cab
Apply suggestions from code review
gewarren Jul 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions xml/System/GCMemoryInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

## Remarks

A GC is identified by its <xref:System.GCMemoryInfo.Index>, which starts from 1 and increases with each GC. If you are asking for a GC that doesn't exist, for example, you called the <xref:System.GC.GetGCMemoryInfo%2A> method before a GC happened, or you're asking for a GC of <xref:System.GCKind.FullBlocking?displayProperty=nameWithType> and no full blocking GCs have happened, you will get all 0's in the info, including the <xref:System.GCMemoryInfo.Index>. You can use index 0 to detect that no GCs, or no GCs of the kind you specified, have occurred.
A garbage collection (GC) is identified by its <xref:System.GCMemoryInfo.Index>, which starts from 1 and increases with each GC. If you are asking for a GC that doesn't exist, for example, you called the <xref:System.GC.GetGCMemoryInfo%2A> method before a GC happened, or you're asking for a GC of <xref:System.GCKind.FullBlocking?displayProperty=nameWithType> and no full blocking GCs have happened, you will get all 0's in the info, including the <xref:System.GCMemoryInfo.Index>. You can use index 0 to detect that no GCs, or no GCs of the kind you specified, have occurred.

]]></format>
</remarks>
Expand Down Expand Up @@ -75,9 +75,9 @@ A GC is identified by its <xref:System.GCMemoryInfo.Index>, which starts from 1
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates if this is a concurrent GC (BGC) or not.</summary>
<summary>Gets a value that indicates if this is a concurrent GC (background GC) or not.</summary>
<value>
<see langword="true" /> if this is a concurrent GC (BGC); <see langword="false" /> otherwise.</value>
<see langword="true" /> if this is a concurrent GC (background GC); <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -162,7 +162,7 @@ The memory after `OBJ_D` is not considered part of the `FragmentedBytes` but is
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the generation this GC collected. Collecting a generation also collected younger generations.</summary>
<summary>Gets the generation this GC collected. Collecting a generation also collects younger generations.</summary>
<value>The generation this GC collected.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -279,9 +279,9 @@ The memory after `OBJ_D` is not considered part of the `FragmentedBytes` but is
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the memory load when the last garbage collection occurred.</summary>
<value>The memory load when the last garbage collection occurred.</value>
<remarks>To be added.</remarks>
<summary>Gets the physical memory load when the last garbage collection occurred.</summary>
<value>The physical memory load, in bytes, when the last garbage collection occurred.</value>
<remarks>Data is only brought into physical memory on first touch. If you allocated a big object but haven't actually used it, most of its memory isn't in physical memory. In this case, the allocation won't affect the memory load significantly.</remarks>
</Docs>
</Member>
<Member MemberName="PauseDurations">
Expand Down