Feature #10197: document RUBY_* stack size/GC params in ruby.1 manpage

• Status: Closed
• Assignee: ko1 (Koichi Sasada)
• Target version: 2.2.0

[normalperson (Eric Wong)]

Good idea or too implementation/internals-dependent?
We can note it is implementation-dependent behavior in the manpage.
I can prepare patches based on existing NEWS-* files.

[ko1 (Koichi Sasada)]

Most of environemnt variables should be implementation dependent.

I recommend you to use comment in gc.c:
https://github.com/ruby/ruby/blob/trunk/gc.c#L5848

Maybe on 2.2 I will add some more variables.

[normalperson (Eric Wong)]

• File 0001-man-ruby.1-document-stack-size-env-variables.patch 0001-man-ruby.1-document-stack-size-env-variables.patch added

Work-in-progress here with *_STACK_SIZE.
I added a header section hopefully clarifying the difference between
VM vs. machine stack size changes.

This manpage feels a bit long, I think the FEATURES section should be moved to a
new ruby(7) manpage. Perhaps these new tuning variables should also be
moved to a ruby_tuning(7) variable for longer explanations

• Status changed from Open to Closed
• % Done changed from 0 to 100

Applied in changeset r47713.

---

man/ruby.1: document stack size env variables

[Feature #10197]

[normalperson (Eric Wong)]

Committed GC stuff as r48855, hopefully this all makes sense to people
who are not familiar with Ruby internals.