1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Escape all usages of GC

Browse Source 
RDoc was making every usage of the word "GC" link to the page for GC
(which is the same page).
This commit is contained in:
Peter Zhu 2022-12-20 15:16:36 -05:00
parent 63fe03aa4e
commit 9f4472cad7
2 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
gc.c
View File

@ -10798,7 +10798,7 @@ gc_update_references(rb_objspace_t *objspace)
* call-seq: * call-seq:
* GC.latest_compact_info -> hash * GC.latest_compact_info -> hash
* *
* Returns information about object moved in the most recent GC compaction. * Returns information about object moved in the most recent \GC compaction.
* *
* The returned hash has two keys :considered and :moved. The hash for * The returned hash has two keys :considered and :moved. The hash for
* :considered lists the number of objects that were considered for movement * :considered lists the number of objects that were considered for movement
@ -10908,7 +10908,7 @@ heap_check_moved_i(void *vstart, void *vend, size_t stride, void *data)
* This method is implementation specific and not expected to be implemented * This method is implementation specific and not expected to be implemented
* in any implementation besides MRI. * in any implementation besides MRI.
* *
* To test whether GC compaction is supported, use the idiom: * To test whether \GC compaction is supported, use the idiom:
* *
* GC.respond_to?(:compact) * GC.respond_to?(:compact)
*/ */
@ -13505,7 +13505,7 @@ gc_prof_set_heap_info(rb_objspace_t *objspace)
* call-seq: * call-seq:
* GC::Profiler.clear -> nil * GC::Profiler.clear -> nil
* *
* Clears the GC profiler data. * Clears the \GC profiler data.
* *
*/ */
@ -13819,7 +13819,7 @@ gc_profile_total_time(VALUE self)
* call-seq: * call-seq:
* GC::Profiler.enabled? -> true or false * GC::Profiler.enabled? -> true or false
* *
* The current status of GC profile mode. * The current status of \GC profile mode.
*/ */
static VALUE static VALUE
@ -13833,7 +13833,7 @@ gc_profile_enable_get(VALUE self)
* call-seq: * call-seq:
* GC::Profiler.enable -> nil * GC::Profiler.enable -> nil
* *
* Starts the GC profiler. * Starts the \GC profiler.
* *
*/ */
@ -13850,7 +13850,7 @@ gc_profile_enable(VALUE _)
* call-seq: * call-seq:
* GC::Profiler.disable -> nil * GC::Profiler.disable -> nil
* *
* Stops the GC profiler. * Stops the \GC profiler.
* *
*/ */
@ -14573,7 +14573,7 @@ Init_GC(void)
{ {
VALUE opts; VALUE opts;
/* GC build options */ /* \GC build options */
rb_define_const(rb_mGC, "OPTS", opts = rb_ary_new()); rb_define_const(rb_mGC, "OPTS", opts = rb_ary_new());
#define OPT(o) if (o) rb_ary_push(opts, rb_fstring_lit(#o)) #define OPT(o) if (o) rb_ary_push(opts, rb_fstring_lit(#o))
OPT(GC_DEBUG); OPT(GC_DEBUG);

44
gc.rb
View File

@ -6,7 +6,7 @@
# Some of the underlying methods are also available via the ObjectSpace # Some of the underlying methods are also available via the ObjectSpace
# module. # module.
# #
# You may obtain information about the operation of the GC through # You may obtain information about the operation of the \GC through
# GC::Profiler. # GC::Profiler.
module GC module GC
@ -24,7 +24,7 @@ module GC
# #
# def GC.start(full_mark: true, immediate_sweep: true); end # def GC.start(full_mark: true, immediate_sweep: true); end
# #
# Use full_mark: false to perform a minor GC. # Use full_mark: false to perform a minor \GC.
# Use immediate_sweep: false to defer sweeping (use lazy sweep). # Use immediate_sweep: false to defer sweeping (use lazy sweep).
# #
# Note: These keyword arguments are implementation and version dependent. They # Note: These keyword arguments are implementation and version dependent. They
@ -67,7 +67,7 @@ module GC
# call-seq: # call-seq:
# GC.stress -> integer, true or false # GC.stress -> integer, true or false
# #
# Returns current status of GC stress mode. # Returns current status of \GC stress mode.
def self.stress def self.stress
Primitive.gc_stress_get Primitive.gc_stress_get
end end
@ -75,9 +75,9 @@ module GC
# call-seq: # call-seq:
# GC.stress = flag -> flag # GC.stress = flag -> flag
# #
# Updates the GC stress mode. # Updates the \GC stress mode.
# #
# When stress mode is enabled, the GC is invoked at every GC opportunity: # When stress mode is enabled, the \GC is invoked at every \GC opportunity:
# all memory and object allocations. # all memory and object allocations.
# #
# Enabling stress mode will degrade performance, it is only for debugging. # Enabling stress mode will degrade performance, it is only for debugging.
@ -93,9 +93,9 @@ module GC
# call-seq: # call-seq:
# GC.count -> Integer # GC.count -> Integer
# #
# The number of times GC occurred. # The number of times \GC occurred.
# #
# It returns the number of times GC occurred since the process started. # It returns the number of times \GC occurred since the process started.
def self.count def self.count
Primitive.gc_count Primitive.gc_count
end end
@ -105,12 +105,12 @@ module GC
# GC.stat(hash) -> Hash # GC.stat(hash) -> Hash
# GC.stat(:key) -> Numeric # GC.stat(:key) -> Numeric
# #
# Returns a Hash containing information about the GC. # Returns a Hash containing information about the \GC.
# #
# The contents of the hash are implementation specific and may change in # The contents of the hash are implementation specific and may change in
# the future without notice. # the future without notice.
# #
# The hash includes information about internal statistics about GC such as: # The hash includes information about internal statistics about \GC such as:
# #
# [count] # [count]
# The total number of garbage collections ran since application start # The total number of garbage collections ran since application start
@ -123,7 +123,7 @@ module GC
# The number of pages that can fit into the buffer that holds references to # The number of pages that can fit into the buffer that holds references to
# all pages # all pages
# [heap_allocatable_pages] # [heap_allocatable_pages]
# The total number of pages the application could allocate without additional GC # The total number of pages the application could allocate without additional \GC
# [heap_available_slots] # [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] # [heap_live_slots]
@ -133,7 +133,7 @@ module GC
# [heap_final_slots] # [heap_final_slots]
# The total number of slots with pending finalizers to be run # The total number of slots with pending finalizers to be run
# [heap_marked_slots] # [heap_marked_slots]
# The total number of objects marked in the last GC # The total number of objects marked in the last \GC
# [heap_eden_pages] # [heap_eden_pages]
# The total number of pages which contain at least one live slot # The total number of pages which contain at least one live slot
# [heap_tomb_pages] # [heap_tomb_pages]
@ -147,9 +147,9 @@ module GC
# [total_freed_objects] # [total_freed_objects]
# The cumulative number of objects freed since application start # The cumulative number of objects freed since application start
# [malloc_increase_bytes] # [malloc_increase_bytes]
# Amount of memory allocated on the heap for objects. Decreased by any GC # Amount of memory allocated on the heap for objects. Decreased by any \GC
# [malloc_increase_bytes_limit] # [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] # [minor_gc_count]
# The total number of minor garbage collections run since process start # The total number of minor garbage collections run since process start
# [major_gc_count] # [major_gc_count]
@ -165,15 +165,15 @@ module GC
# The total number of objects without write barriers # The total number of objects without write barriers
# [remembered_wb_unprotected_objects_limit] # [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 # major \GC is triggered
# [old_objects] # [old_objects]
# Number of live, old objects which have survived at least 3 garbage collections # Number of live, old objects which have survived at least 3 garbage collections
# [old_objects_limit] # [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] # [oldmalloc_increase_bytes]
# Amount of memory allocated on the heap for objects. Decreased by major GC # Amount of memory allocated on the heap for objects. Decreased by major \GC
# [oldmalloc_increase_bytes_limit] # [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, # If the optional argument, hash, is given,
# it is overwritten and returned. # it is overwritten and returned.
@ -191,7 +191,7 @@ module GC
# GC.stat_heap(heap_name, hash) -> Hash # GC.stat_heap(heap_name, hash) -> Hash
# GC.stat_heap(heap_name, :key) -> Numeric # GC.stat_heap(heap_name, :key) -> Numeric
# #
# Returns information for memory pools in the GC. # Returns information for memory pools in the \GC.
# #
# If the first optional argument, +heap_name+, is passed in and not +nil+, it # If the first optional argument, +heap_name+, is passed in and not +nil+, it
# returns a +Hash+ containing information about the particular memory pool. # returns a +Hash+ containing information about the particular memory pool.
@ -244,7 +244,7 @@ module GC
# #
# This function expands the heap to ensure room to move all objects, # This function expands the heap to ensure room to move all objects,
# compacts the heap to make sure everything moves, updates all references, # compacts the heap to make sure everything moves, updates all references,
# then performs a full GC. If any object contains a reference to a T_MOVED # then performs a full \GC. If any object contains a reference to a T_MOVED
# object, that object should be pushed on the mark stack, and will # object, that object should be pushed on the mark stack, and will
# make a SEGV. # make a SEGV.
def self.verify_compaction_references(toward: nil, double_heap: false, expand_heap: false) def self.verify_compaction_references(toward: nil, double_heap: false, expand_heap: false)
@ -255,9 +255,9 @@ module GC
# call-seq: # call-seq:
# GC.measure_total_time = true/false # GC.measure_total_time = true/false
# #
# Enable to measure GC time. # Enable to measure \GC time.
# You can get the result with <tt>GC.stat(:time)</tt>. # You can get the result with <tt>GC.stat(:time)</tt>.
# Note that GC time measurement can cause some performance overhead. # Note that \GC time measurement can cause some performance overhead.
def self.measure_total_time=(flag) def self.measure_total_time=(flag)
Primitive.cstmt! %{ Primitive.cstmt! %{
rb_objspace.flags.measure_gc = RTEST(flag) ? TRUE : FALSE; rb_objspace.flags.measure_gc = RTEST(flag) ? TRUE : FALSE;
@ -279,7 +279,7 @@ module GC
# call-seq: # call-seq:
# GC.total_time -> int # GC.total_time -> int
# #
# Return measured GC total time in nano seconds. # Return measured \GC total time in nano seconds.
def self.total_time def self.total_time
Primitive.cexpr! %{ Primitive.cexpr! %{
ULL2NUM(rb_objspace.profile.total_time_ns) ULL2NUM(rb_objspace.profile.total_time_ns)