aboutsummaryrefslogtreecommitdiffstats
path: root/gc.rb
diff options
context:
space:
mode:
authorPeter Zhu <peter@peterzhu.ca>2023-01-05 09:24:32 -0500
committerPeter Zhu <peter@peterzhu.ca>2023-01-05 09:24:32 -0500
commit358f325bf8cd6fca3da1343e9606176cad2c70bd (patch)
tree064476f0509947a3d304565edd0a5209b92133b4 /gc.rb
parentf9148d1580e43038d9d2319e59086d38c4aa9c47 (diff)
downloadruby-358f325bf8cd6fca3da1343e9606176cad2c70bd.tar.gz
[DOC] Fix formatting for GC.stat
Diffstat (limited to 'gc.rb')
-rw-r--r--gc.rb12
1 files changed, 6 insertions, 6 deletions
diff --git a/gc.rb b/gc.rb
index 57aeeb9131..495f203487 100644
--- a/gc.rb
+++ b/gc.rb
@@ -118,14 +118,14 @@ module GC
# [time]
# The total time spent in garbage collections (in milliseconds)
# [heap_allocated_pages]
- # The total number of `:heap_eden_pages` + `:heap_tomb_pages`
+ # The total number of +:heap_eden_pages+ + +:heap_tomb_pages+
# [heap_sorted_length]
# The number of pages that can fit into the buffer that holds references to
# all pages
# [heap_allocatable_pages]
# The total number of pages the application could allocate without additional \GC
# [heap_available_slots]
- # The total number of slots in all `:heap_allocated_pages`
+ # The total number of slots in all +:heap_allocated_pages+
# [heap_live_slots]
# The total number of slots which contain live objects
# [heap_free_slots]
@@ -149,7 +149,7 @@ module GC
# [malloc_increase_bytes]
# Amount of memory allocated on the heap for objects. Decreased by any \GC
# [malloc_increase_bytes_limit]
- # When `:malloc_increase_bytes` crosses this limit, \GC is triggered
+ # When +:malloc_increase_bytes+ crosses this limit, \GC is triggered
# [minor_gc_count]
# The total number of minor garbage collections run since process start
# [major_gc_count]
@@ -164,16 +164,16 @@ module GC
# [remembered_wb_unprotected_objects]
# The total number of objects without write barriers
# [remembered_wb_unprotected_objects_limit]
- # When `:remembered_wb_unprotected_objects` crosses this limit,
+ # When +:remembered_wb_unprotected_objects+ crosses this limit,
# major \GC is triggered
# [old_objects]
# Number of live, old objects which have survived at least 3 garbage collections
# [old_objects_limit]
- # When `:old_objects` crosses this limit, major \GC is triggered
+ # When +:old_objects+ crosses this limit, major \GC is triggered
# [oldmalloc_increase_bytes]
# Amount of memory allocated on the heap for objects. Decreased by major \GC
# [oldmalloc_increase_bytes_limit]
- # When `:old_malloc_increase_bytes` crosses this limit, major \GC is triggered
+ # When +:old_malloc_increase_bytes+ crosses this limit, major \GC is triggered
#
# If the optional argument, hash, is given,
# it is overwritten and returned.