aboutsummaryrefslogtreecommitdiff
path: root/manual/manual.of
diff options
context:
space:
mode:
Diffstat (limited to 'manual/manual.of')
-rw-r--r--manual/manual.of28
1 files changed, 14 insertions, 14 deletions
diff --git a/manual/manual.of b/manual/manual.of
index ef1bdfd2..e6a3cd9e 100644
--- a/manual/manual.of
+++ b/manual/manual.of
@@ -664,7 +664,7 @@ Values equal to or less than 100 mean the collector will not wait to
664start a new cycle. 664start a new cycle.
665A value of 200 means that the collector waits for 665A value of 200 means that the collector waits for
666the total number of objects to double before starting a new cycle. 666the total number of objects to double before starting a new cycle.
667The default value is 200; the maximum value is 1000. 667The default value is 300; the maximum value is 1000.
668 668
669The garbage-collector step multiplier 669The garbage-collector step multiplier
670controls the speed of the collector relative to 670controls the speed of the collector relative to
@@ -674,7 +674,9 @@ how many objects it marks or sweeps for each object created.
674Larger values make the collector more aggressive. 674Larger values make the collector more aggressive.
675Beware that values too small can 675Beware that values too small can
676make the collector too slow to ever finish a cycle. 676make the collector too slow to ever finish a cycle.
677The default value is 300; the maximum value is 1000. 677The default value is 200; the maximum value is 1000.
678As a special case, a zero value means unlimited work,
679effectively producing a non-incremental, stop-the-world collector.
678 680
679The garbage-collector step size controls the 681The garbage-collector step size controls the
680size of each incremental step, 682size of each incremental step,
@@ -682,9 +684,7 @@ specifically how many objects the interpreter creates
682before performing a step. 684before performing a step.
683This parameter is logarithmic: 685This parameter is logarithmic:
684A value of @M{n} means the interpreter will create @M{2@sp{n}} 686A value of @M{n} means the interpreter will create @M{2@sp{n}}
685objects between steps and perform equivalent work during the step. 687objects between steps.
686A large value (e.g., 60) makes the collector a stop-the-world
687(non-incremental) collector.
688The default value is 8, 688The default value is 8,
689which means steps of approximately @N{256 objects}. 689which means steps of approximately @N{256 objects}.
690 690
@@ -3306,43 +3306,43 @@ For options that need extra arguments,
3306they are listed after the option. 3306they are listed after the option.
3307@description{ 3307@description{
3308 3308
3309@item{@id{LUA_GCCOLLECT}| 3309@item{@defid{LUA_GCCOLLECT}|
3310Performs a full garbage-collection cycle. 3310Performs a full garbage-collection cycle.
3311} 3311}
3312 3312
3313@item{@id{LUA_GCSTOP}| 3313@item{@defid{LUA_GCSTOP}|
3314Stops the garbage collector. 3314Stops the garbage collector.
3315} 3315}
3316 3316
3317@item{@id{LUA_GCRESTART}| 3317@item{@defid{LUA_GCRESTART}|
3318Restarts the garbage collector. 3318Restarts the garbage collector.
3319} 3319}
3320 3320
3321@item{@id{LUA_GCCOUNT}| 3321@item{@defid{LUA_GCCOUNT}|
3322Returns the current amount of memory (in Kbytes) in use by Lua. 3322Returns the current amount of memory (in Kbytes) in use by Lua.
3323} 3323}
3324 3324
3325@item{@id{LUA_GCCOUNTB}| 3325@item{@defid{LUA_GCCOUNTB}|
3326Returns the remainder of dividing the current amount of bytes of 3326Returns the remainder of dividing the current amount of bytes of
3327memory in use by Lua by 1024. 3327memory in use by Lua by 1024.
3328} 3328}
3329 3329
3330@item{@id{LUA_GCSTEP}| 3330@item{@defid{LUA_GCSTEP}|
3331Performs a step of garbage collection. 3331Performs a step of garbage collection.
3332} 3332}
3333 3333
3334@item{@id{LUA_GCISRUNNING}| 3334@item{@defid{LUA_GCISRUNNING}|
3335Returns a boolean that tells whether the collector is running 3335Returns a boolean that tells whether the collector is running
3336(i.e., not stopped). 3336(i.e., not stopped).
3337} 3337}
3338 3338
3339@item{@id{LUA_GCINC} (int pause, int stepmul, int stepsize)| 3339@item{@defid{LUA_GCINC} (int pause, int stepmul, int stepsize)|
3340Changes the collector to incremental mode 3340Changes the collector to incremental mode
3341with the given parameters @see{incmode}. 3341with the given parameters @see{incmode}.
3342Returns the previous mode (@id{LUA_GCGEN} or @id{LUA_GCINC}). 3342Returns the previous mode (@id{LUA_GCGEN} or @id{LUA_GCINC}).
3343} 3343}
3344 3344
3345@item{@id{LUA_GCGEN} (int minormul, int minormajor, int majorminor)| 3345@item{@defid{LUA_GCGEN} (int minormul, int minormajor, int majorminor)|
3346Changes the collector to generational mode 3346Changes the collector to generational mode
3347with the given parameters @see{genmode}. 3347with the given parameters @see{genmode}.
3348Returns the previous mode (@id{LUA_GCGEN} or @id{LUA_GCINC}). 3348Returns the previous mode (@id{LUA_GCGEN} or @id{LUA_GCINC}).