Feature #10197

document RUBY_* stack size/GC params in ruby.1 manpage

Added by Eric Wong 12 months ago. Updated 9 months ago.

[ruby-core:64717]
Status:Closed
Priority:Normal
Assignee:Koichi Sasada

Description

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.

0001-man-ruby.1-document-stack-size-env-variables.patch Magnifier (1.62 KB) Eric Wong, 09/13/2014 04:40 AM

Associated revisions

Revision 47713
Added by normal 11 months ago

man/ruby.1: document stack size env variables

[Feature #10197]

Revision 47713
Added by normal 11 months ago

man/ruby.1: document stack size env variables

[Feature #10197]

Revision 48855
Added by normal 9 months ago

GC documentation update

  • gc.c (GC_HEAP_FREE_SLOTS): move definition to match use order
    (RUBY_GC_HEAP_GROWTH_SLOTS): s/factor/number of slots/

  • man/ruby.1: add section for GC environment variables
    [Feature #10197]

Revision 48855
Added by normal 9 months ago

GC documentation update

  • gc.c (GC_HEAP_FREE_SLOTS): move definition to match use order
    (RUBY_GC_HEAP_GROWTH_SLOTS): s/factor/number of slots/

  • man/ruby.1: add section for GC environment variables
    [Feature #10197]

History

#1 Updated by Koichi Sasada 12 months ago

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.

#2 Updated by Eric Wong 12 months ago

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

#3 Updated by Anonymous 11 months ago

  • 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]

#4 Updated by Eric Wong 9 months ago

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

Also available in: Atom PDF