From dbefef063babe6a788abc89634bf84522844d98a Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Wed, 7 Jul 2021 14:14:35 -0700 Subject: [PATCH 1/2] Clarify memory load --- xml/System/GCMemoryInfo.xml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/xml/System/GCMemoryInfo.xml b/xml/System/GCMemoryInfo.xml index 2ed4d57bd05..2ca458a51b9 100644 --- a/xml/System/GCMemoryInfo.xml +++ b/xml/System/GCMemoryInfo.xml @@ -29,7 +29,7 @@ ## Remarks -A GC is identified by its , 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 method before a GC happened, or you're asking for a GC of and no full blocking GCs have happened, you will get all 0's in the info, including the . 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 , 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 method before a GC happened, or you're asking for a GC of and no full blocking GCs have happened, you will get all 0's in the info, including the . You can use index 0 to detect that no GCs, or no GCs of the kind you specified, have occurred. ]]> @@ -75,9 +75,9 @@ A GC is identified by its , which starts from 1 System.Boolean - Gets a value that indicates if this is a concurrent GC (BGC) or not. + Gets a value that indicates if this is a background or concurrent GC or not. - if this is a concurrent GC (BGC); otherwise. + if this is a background or concurrent GC; otherwise. To be added. @@ -162,7 +162,7 @@ The memory after `OBJ_D` is not considered part of the `FragmentedBytes` but is System.Int32 - Gets the generation this GC collected. Collecting a generation also collected younger generations. + Gets the generation this GC collected. Collecting a generation also collects younger generations. The generation this GC collected. To be added. @@ -279,9 +279,9 @@ The memory after `OBJ_D` is not considered part of the `FragmentedBytes` but is System.Int64 - Gets the memory load when the last garbage collection occurred. - The memory load when the last garbage collection occurred. - To be added. + Gets the physical memory load when the last garbage collection occurred. + The physical memory load, in bytes, when the last garbage collection occurred. + If you don't touch the pages of an object, the memory load doesn't change significantly. From 0af6cab2dc1c1b25c2055917c108d4fec74882a1 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Wed, 7 Jul 2021 15:25:53 -0700 Subject: [PATCH 2/2] Apply suggestions from code review --- xml/System/GCMemoryInfo.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System/GCMemoryInfo.xml b/xml/System/GCMemoryInfo.xml index 2ca458a51b9..82bd96c783a 100644 --- a/xml/System/GCMemoryInfo.xml +++ b/xml/System/GCMemoryInfo.xml @@ -75,9 +75,9 @@ A garbage collection (GC) is identified by its , System.Boolean - Gets a value that indicates if this is a background or concurrent GC or not. + Gets a value that indicates if this is a concurrent GC (background GC) or not. - if this is a background or concurrent GC; otherwise. + if this is a concurrent GC (background GC); otherwise. To be added. @@ -281,7 +281,7 @@ The memory after `OBJ_D` is not considered part of the `FragmentedBytes` but is Gets the physical memory load when the last garbage collection occurred. The physical memory load, in bytes, when the last garbage collection occurred. - If you don't touch the pages of an object, the memory load doesn't change significantly. + 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.