runtime/metrics: tweak wording of stack and unused memory metrics
This change tweaks and simplifies the descriptions of a couple metrics
to make them easier to parse (for humans).
Change-Id: I852654c7e7042c662ebdfa6334e3baf49ca4b33c
Reviewed-on: https://go-review.googlesource.com/c/go/+/272566
Trust: Michael Knyszek <mknyszek@google.com>
Run-TryBot: Michael Knyszek <mknyszek@google.com>
Reviewed-by: Robert Findley <rfindley@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
diff --git a/src/runtime/metrics/description.go b/src/runtime/metrics/description.go
index 9d3611b..32af5d1 100644
--- a/src/runtime/metrics/description.go
+++ b/src/runtime/metrics/description.go
@@ -113,14 +113,13 @@
Kind: KindUint64,
},
{
- Name: "/memory/classes/heap/stacks:bytes",
- Description: "Memory allocated from the heap that is reserved for stack space. Not all of it is necessarily " +
- "simultaneously in use, but it may not be used for any other purpose.",
- Kind: KindUint64,
+ Name: "/memory/classes/heap/stacks:bytes",
+ Description: "Memory allocated from the heap that is reserved for stack space, whether or not it is currently in-use.",
+ Kind: KindUint64,
},
{
Name: "/memory/classes/heap/unused:bytes",
- Description: "Memory that is reserved for heap objects but is otherwise not currently used to hold heap objects.",
+ Description: "Memory that is reserved for heap objects but is not currently used to hold heap objects.",
Kind: KindUint64,
},
{
diff --git a/src/runtime/metrics/doc.go b/src/runtime/metrics/doc.go
index f58cdcd..42b5bc3 100644
--- a/src/runtime/metrics/doc.go
+++ b/src/runtime/metrics/doc.go
@@ -86,12 +86,11 @@
/memory/classes/heap/stacks:bytes
Memory allocated from the heap that is reserved for stack
- space. Not all of it is necessarily simultaneously in use, but
- it may not be used for any other purpose.
+ space, whether or not it is currently in-use.
/memory/classes/heap/unused:bytes
- Memory that is reserved for heap objects but is otherwise not
- currently used to hold heap objects.
+ Memory that is reserved for heap objects but is not currently
+ used to hold heap objects.
/memory/classes/metadata/mcache/free:bytes
Memory that is reserved for runtime mcache structures, but
