72 Commits
Author SHA1 Message Date
Satoshi Tagomori 6b35f074bd Box: [DOC] Add RUBY_BOX in Environment 2025-12-16 22:23:24 +09:00
Kouhei Yanagita 0f45d0c484 Update man and help: -d option set $VERBOSE to true 2025-11-27 16:00:35 +09:00
kyontan 3c92fe13f8 [DOC] Fix minor miscalculation of stack size 2025-03-07 16:18:25 -05:00
Étienne Barrié c27f433d7c Fix RUBY_PAGER in manpage 2025-02-24 10:47:58 +01:00
Misaki Shioi 9f924e2f13 Improve APIs for Globally Enabling/Disabling fast_fallback in Socket (#12257)
This change includes the following updates:
- Added an environment variable `RUBY_TCP_NO_FAST_FALLBACK` to control enabling/disabling fast_fallback
- Updated documentation and man pages
- Revised the implementation of Socket.tcp_fast_fallback= and Socket.tcp_fast_fallback, which previously performed dynamic name resolution of constants and variables. As a result, the following performance improvements were achieved:

(Case of 1000 executions of `TCPSocket.new` to the local host)

Rehearsal -----------------------------------------
before   0.031462   0.147946   0.179408 (  0.249279)
after    0.031164   0.146839   0.178003 (  0.346935)
-------------------------------- total: 0.178003sec

            user     system      total        real
before   0.027584   0.138712   0.166296 (  0.233356)
after    0.025953   0.127608   0.153561 (  0.237971)
2024-12-14 15:51:19 +09:00
Aaron PattersonandJohn Hawthorn fffef9aa5d Add an environment variable for controlling the default Thread quantum
This commit adds an environment variable `RUBY_THREAD_TIMESLICE` for
specifying the default thread quantum in milliseconds.  You can adjust
this variable to tune throughput, which is especially useful on
multithreaded systems that are mixing CPU bound work and IO bound work.

The default quantum remains 100ms.

[Feature #20861]

Co-Authored-By: John Hawthorn <john@hawthorn.email>
2024-12-12 16:04:49 -08:00
Nobuyoshi Nakada 1ac3a71d66 [DOC] ruby.1: Refine RUBY_GC_HEAP_n_INIT_SLOTS description 2024-06-04 18:01:58 +09:00
Nobuyoshi Nakada bdcdeb7918 [DOC] ruby.1: mandoc is not markdown 2024-06-04 17:56:06 +09:00
Nobuyoshi Nakada 7aa1bca2c9 [DOC] man: Add environment variable RUBY_PAGER 2024-06-03 23:10:05 +09:00
Nobuyoshi Nakada fa8984df2e [DOC] man: Add environment variable RUBY_MAX_CPU and RUBY_MN_THREADS 2024-06-03 23:10:05 +09:00
Nobuyoshi Nakada 2192b0eaa0 [DOC] man: Add environment variable RUBY_FREE_AT_EXIT 2024-06-03 23:10:05 +09:00
Nobuyoshi Nakada c08783f398 [DOC] man: Remove environment variable RUBY_GC_HEAP_INIT_SLOTS 2024-06-03 23:10:05 +09:00
Nobuyoshi Nakada 0fb2147284 [DOC] man: Add environment variable RUBY_IO_BUFFER_DEFAULT_SIZE 2024-06-03 23:10:05 +09:00
Nobuyoshi Nakada c25f653047 [DOC] man: Add environment variable RUBY_SHARED_FIBER_POOL_FREE_STACKS 2024-06-03 23:10:05 +09:00
Nobuyoshi Nakada 589764b1c9 [DOC] man: Add missing GC environment variables 2024-06-03 23:10:05 +09:00
Nobuyoshi Nakada 1ca4c8b41f [DOC] man: Fix up formatting 2024-06-03 23:10:05 +09:00
Nobuyoshi Nakada d10615c064 [DOC] Update --dump option arguments in the ruby man page
Related to [Feature #20329].
2024-05-09 11:40:02 +09:00
Richard Ricciardelli 7a8882bc30 [DOC] Fix typo: Replace documentatation with documentation 2024-04-30 10:34:40 +09:00
Iztok Fister Jr b0e0a2a64d [DOC] Fix two minor typos on manual page 2024-01-13 09:01:30 +09:00
Nobuyoshi Nakada 904413997f [Feature #19790] [DOC] Fix the manual page as crash report
Also add missing `%f` and `%F`.
2023-09-25 23:22:52 +09:00
Nobuyoshi Nakada bab01d284c [Feature #19790] Rename BUGREPORT_PATH as CRASH_REPORT 2023-09-25 22:57:28 +09:00
Nobuyoshi Nakada 70e8a08295 Add --bugreport-path option
It has precedence over the environment variable `RUBY_BUGREPORT_PATH`.
2023-09-25 22:57:28 +09:00
Nobuyoshi Nakada 696f08238b Add "piping bug reports to a program" to the manual page 2023-09-25 22:57:28 +09:00
Nobuyoshi Nakada 6bb4c9de09 Add RUBY_BUGREPORT_PATH to the manual page 2023-09-25 22:57:28 +09:00
Peter Zhu 0aa404b957 Change heap init environment variable names
This commit changes RUBY_GC_HEAP_INIT_SIZE_{40,80,160,320,640}_SLOTS to
RUBY_GC_HEAP_{0,1,2,3,4}_INIT_SLOTS. This is easier to use because the
user does not need to determine the slot sizes (which can vary between
32 and 64 bit systems). They now just use the heap names
(`GC.stat_heap.keys`).
2023-08-30 19:37:11 -04:00
Tom Stuart c32b608e76 Add --backtrace-limit option to the man page 2023-07-16 00:39:01 +09:00
Jemma Issroff 1272865a8e Fix broken wiki links (#8002)
Since [Misc #19679] migrated the wiki, these links should be updated
to their new locations.
2023-06-29 17:00:40 -04:00
Yla Aioi 3fe0f8c68b [Bug #19685]: Add -y and --yydebug document to --help
Add -y option information to `--help`
Fix a warning on the man page
2023-06-05 12:05:58 +09:00
Jean Boussier 3ab3455145 Add RUBY_GC_HEAP_INIT_SIZE_%d_SLOTS to pre-init pools granularly
The old RUBY_GC_HEAP_INIT_SLOTS isn't really usable anymore as
it initalize all the pools by the same factor, but it's unlikely
that pools will need similar sizes.

In production our 40B pool is 5 to 6 times bigger than our 80B pool.
2023-02-08 09:26:07 +01:00
Matt Valentine-House ca85bd818a [ci skip] Improve man page docs around --dump options 2022-06-28 10:10:26 -04:00
Alan Wu eb4e320681 Man page: correct defaults for RUBY_THREAD_VM_STACK_SIZE
See RUBY_VM_THREAD_VM_STACK_SIZE in vm_core.h.
2021-04-20 19:26:15 -04:00
Marcus Stollsteimer 3108ad7bf3 [DOC] Fix grammar: "is same as" -> "is the same as" 2021-01-05 15:13:53 +01:00
Nobuyoshi Nakada 89774a938a [DOC] Update -l option [ci skip]
`-l` option has used `chomp!` since Ruby 2.5.  [Bug #12926]
2020-11-30 19:06:25 +09:00
Nobuyoshi Nakada db16629008 Fixed misspellings
Fixed misspellings reported at [Bug #16437], only in ruby and rubyspec.
2019-12-20 09:32:42 +09:00
nobu 93cb2b3563 Updated dates in man pages
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66303 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-12-10 01:57:48 +00:00
stomar 9d0699819a man/ruby.1: [DOC] fix grammar
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@63157 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-04-14 16:48:40 +00:00
nobu 07889292dd ruby.1: [DOC] options to exit [ci skip]
* man/ruby.1: `--copyright` and `--version` quit immediately, and
  also `--verbose` if no scripts are given.
  [ruby-core:86391] [Bug #14633]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@63038 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-03-30 02:52:12 +00:00
eregon 60c253e28f * man/ruby.1: Move paragraph which is related to -S, not -s.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59508 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-08-04 17:05:43 +00:00
stomar cafa438f80 improve man pages
* man/ruby.1, man/erb.1, man/goruby.1, man/irb.1:
  fix document title formatting and volume name,
  improve "REPORTING BUGS" section: fix mdoc formatting error
  (wrong macro for bullet list items), small rewordings.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58411 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-04-20 07:46:22 +00:00
knu c2e59df31b Remove Ns before puctuation
* man/erb.1, man/irb.1, man/ri.1, man/ruby.1: Remove Ns before
  puctuation.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56256 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-09-26 12:39:18 +00:00
knu 0b5a4e68c3 Update the paragraphs in "Rich Libraries" which included a dead link
* man/ruby.1: Update the paragraphs in "Rich Libraries" which
  included a dead link.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56212 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-09-23 11:21:55 +00:00
knu 7c30df7134 Use the Lk macro for hyperlinks
* man/ruby.1, man/erb.1, man/irb.1, man/ri.1: Use the `Lk` macro
  for hyperlinks, which has been available since mdocml 1.5.1
  (released more than seven years ago).

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56211 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-09-23 11:21:52 +00:00
kazu 07efce075b Use https instead of http in some URLs
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56135 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-09-11 10:33:36 +00:00
nobu 05f1caa1cf Fix typo [ci skip]
* man/ruby.1: fix double word typo.  [Fix GH-1194]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@53516 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-01-12 15:37:42 +00:00
nobu 22d8481f08 fix common misspelling [ci skip]
* compile.c, cont.c, doc, man: fix common misspelling.
  [ruby-core:72466] [Bug #11870]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@53299 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-12-24 23:23:46 +00:00
nobu c87bee1f45 ruby.1: --dump [ci skip]
* man/ruby.1: describe --dump option arguments.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52577 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-11-15 02:04:37 +00:00
nobu eef8b3fc9d optional arguments
* man/ruby.1 (SYNOPSIS): arguments of -F and -K are optional.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52410 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-10-31 06:22:31 +00:00
nobu fb1c88342a remove extraneous space
* man/ruby.1 (SYNOPSIS): remove extraneous space for -K option
  too.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52409 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-10-31 06:02:04 +00:00
nobu afde597521 remove extraneous space
* man/ruby.1 (SYNOPSIS): remove extraneous space for -F option as
  it does not allow spaces before its argument.
  [ruby-core:71283] [Bug #11641]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52408 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-10-31 05:58:12 +00:00
nobu 9cd5c850a4 ruby.1: fix --enable/disable
* man/ruby.1: missing Fl before --{enable|disable}.

* tool/mdoc2man.rb (parse_macro): supprot braces, Bro and Brc.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52407 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-10-31 05:55:28 +00:00