Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GC.auto_compact / GC.auto_compact= の説明を追加 #2475

Merged
merged 2 commits into from
Mar 20, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions refm/api/src/_builtin/GC
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,33 @@ oldmalloc_increase_bytes と呼ばれる。この2つの性質は以下のよう

== Singleton Methods

#@since 3.0.0
--- auto_compact -> bool

auto compaction が有効化どうかを返します。

@return auto compaction が有効な場合 true を返します。
そうでなければ false を返します。

@see [[m:GC.auto_compact=]]

--- auto_compact=(bool)

[[m:GC.compact]] をフルGCで行うかどうかを制御します。

true を設定するとフルGCのタイミングででヒープをコンパクションします。

この機能を有効にするとフルGCのパフォーマンスが低下します。

デフォルトは false です。

詳細は[[feature:17176]]を参照してください。

@param bool フルGCでコンパクションするかどうかを true か false で設定します。

@see [[m:GC.compact]] [[m:GC.auto_compact]]
#@end

--- disable -> bool

ガーベージコレクトを禁止します。
Expand Down