diff options
author | Roberto Ierusalimschy <roberto@inf.puc-rio.br> | 2024-01-16 17:02:55 -0300 |
---|---|---|
committer | Roberto Ierusalimschy <roberto@inf.puc-rio.br> | 2024-01-16 17:02:55 -0300 |
commit | 4a8e48086433ad12f2991c07f3064278714fd0f1 (patch) | |
tree | 7efc32733ceff1ce51930d927292e7b7ce56b175 /manual | |
parent | 17e0c29d9b435392016b707309ed51409b0aea12 (diff) | |
download | lua-4a8e48086433ad12f2991c07f3064278714fd0f1.tar.gz lua-4a8e48086433ad12f2991c07f3064278714fd0f1.tar.bz2 lua-4a8e48086433ad12f2991c07f3064278714fd0f1.zip |
New mechanism to query GC parameters
Diffstat (limited to 'manual')
-rw-r--r-- | manual/manual.of | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/manual/manual.of b/manual/manual.of index 64bb5473..48f396d9 100644 --- a/manual/manual.of +++ b/manual/manual.of | |||
@@ -3345,9 +3345,9 @@ Changes the collector to generational mode. | |||
3345 | Returns the previous mode (@id{LUA_GCGEN} or @id{LUA_GCINC}). | 3345 | Returns the previous mode (@id{LUA_GCGEN} or @id{LUA_GCINC}). |
3346 | } | 3346 | } |
3347 | 3347 | ||
3348 | @item{@defid{LUA_GCSETPARAM} (int param, int value)| | 3348 | @item{@defid{LUA_GCPARAM} (int param, int val)| |
3349 | Changes the values of a parameter of the collector and returns | 3349 | Changes and/or returns the value of a parameter of the collector. |
3350 | the previous value of that parameter. | 3350 | If @id{val} is negative, the call only returns the current value. |
3351 | The argument @id{param} must have one of the following values: | 3351 | The argument @id{param} must have one of the following values: |
3352 | @description{ | 3352 | @description{ |
3353 | @item{@defid{LUA_GCPMINORMUL}| The minor multiplier. } | 3353 | @item{@defid{LUA_GCPMINORMUL}| The minor multiplier. } |
@@ -6390,13 +6390,12 @@ Changes the collector mode to incremental and returns the previous mode. | |||
6390 | Changes the collector mode to generational and returns the previous mode. | 6390 | Changes the collector mode to generational and returns the previous mode. |
6391 | } | 6391 | } |
6392 | 6392 | ||
6393 | @item{@St{setparam}| | 6393 | @item{@St{param}| |
6394 | Changes the values of a parameter of the collector and returns | 6394 | Changes and/or retrieves the values of a parameter of the collector. |
6395 | the previous value of that parameter. | 6395 | This option must be followed by one or two extra arguments: |
6396 | This option must be followed by two extra arguments: | 6396 | The name of the parameter being changed or retrieved (a string) |
6397 | The name of the parameter being changed (a string) | 6397 | and an optional new value for that parameter (an integer). |
6398 | and the new value for that parameter (an integer). | 6398 | The first argument must have one of the following values: |
6399 | The argument @id{param} must have one of the following values: | ||
6400 | @description{ | 6399 | @description{ |
6401 | @item{@St{minormul}| The minor multiplier. } | 6400 | @item{@St{minormul}| The minor multiplier. } |
6402 | @item{@St{majorminor}| The major-minor multiplier. } | 6401 | @item{@St{majorminor}| The major-minor multiplier. } |
@@ -6405,6 +6404,10 @@ The argument @id{param} must have one of the following values: | |||
6405 | @item{@St{stepmul}| The step multiplier. } | 6404 | @item{@St{stepmul}| The step multiplier. } |
6406 | @item{@St{stepsize}| The step size. } | 6405 | @item{@St{stepsize}| The step size. } |
6407 | } | 6406 | } |
6407 | The call always returns the previous value of the parameter. | ||
6408 | If the call does not give a new value, | ||
6409 | the value is left unchanged. | ||
6410 | |||
6408 | Lua rounds these values before storing them; | 6411 | Lua rounds these values before storing them; |
6409 | so, the value returned as the previous value may not be | 6412 | so, the value returned as the previous value may not be |
6410 | exactly the last value set. | 6413 | exactly the last value set. |
@@ -9298,7 +9301,7 @@ declare a local variable with the same name in the loop body. | |||
9298 | @item{ | 9301 | @item{ |
9299 | Parameters for the garbage collection are not set | 9302 | Parameters for the garbage collection are not set |
9300 | with the options @St{incremental} and @St{generational}; | 9303 | with the options @St{incremental} and @St{generational}; |
9301 | instead, there is a new option @St{setparam} to that end. | 9304 | instead, there is a new option @St{param} to that end. |
9302 | Moreover, there were some changes in the parameters themselves. | 9305 | Moreover, there were some changes in the parameters themselves. |
9303 | } | 9306 | } |
9304 | 9307 | ||
@@ -9327,7 +9330,7 @@ to signal the end of the dump. | |||
9327 | @item{ | 9330 | @item{ |
9328 | Parameters for the garbage collection are not set | 9331 | Parameters for the garbage collection are not set |
9329 | with the options @Lid{LUA_GCINC} and @Lid{LUA_GCGEN}; | 9332 | with the options @Lid{LUA_GCINC} and @Lid{LUA_GCGEN}; |
9330 | instead, there is a new option @Lid{LUA_GCSETPARAM} to that end. | 9333 | instead, there is a new option @Lid{LUA_GCPARAM} to that end. |
9331 | Moreover, there were some changes in the parameters themselves. | 9334 | Moreover, there were some changes in the parameters themselves. |
9332 | } | 9335 | } |
9333 | 9336 | ||