144 Commits

Author SHA1 Message Date
Simon Quigley
b226c59108
[DOC] Fix man page markup for groff 1.24
Two issues caused groff/lintian warnings on the mdoc pages:

1. man/ruby.1: the MISC ENVIRONMENT list for RUBY_TCP_NO_FAST_FALLBACK
   opened a .Bl that was never closed before .Sh SEE ALSO, producing
   "A .Bl directive has no matching .El".

2. man/erb.1 and man/ruby.1: .Bl -tag -width "1234567890123" uses a long
   all-digit width string. Under groff 1.24 that is mishandled and floods
   "cannot adjust line; overset by ~5e7n" warnings, and mangled OPTIONS
   rendering. Replace it with -width "--encoding" (a representative tag).

Verified with man --warnings: 0 warnings on erb.1/ruby.1/goruby.1 after
this change (was 249 / 1399 / 0 on master).
2026-07-10 00:58:00 +00:00
Jeremy Evans
d216d5fd84 [DOC] Document that RUBY_MAX_CPU affects ractors
This is implied by the fact that non-main ractors use the M:N thread
scheduler, but I expect that some users are not aware of this.

Bump all man page dates as CI requires it.
2026-06-17 18:18:08 -07:00
Samuel Williams
d85c64093b
Fix performance of fiber pool stack tests. (#16570) 2026-03-27 15:32:42 +13:00
Takashi Kokubun
20eeb72085 Commit a diff shown on check_misc
https://github.com/ruby/ruby/actions/runs/22316806245/job/64563939588

Local `make update-man-date` generates nothing but CI complains about
it, so just pushing this diff to make it happy.
2026-02-23 09:20:21 -08:00
Nobuyoshi Nakada
c71999e8cc
[DOC] Update the date in man pages 2026-02-22 20:00:39 +09:00
Alexander Ziaee
07645fe82c
[DOC] man: Increase section number portability
Remove a zero-width space from manual page section numbers improving
portability with the mandoc compiler used on macOS, BSD, and illumos.

Previously it was polluting the whatis(1) database, showing as being
in both sections `1` and also creating a new section `\&1`.

This matches the examples shown in the language references for
the two most widely deployed mdoc(7) compilers, mandoc and groff.

Signed-off-by: Alexander Ziaee <ziaee@google.com>
2026-02-22 14:34:40 +09:00
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
Hiroshi SHIBATA
890020e392
Removed manpages for bundled gems 2025-02-03 14:43:29 +09:00
Nobuyoshi Nakada
71f402c5d5
[DOC] Remove the index file for bundler man pages
Those man pages are not placed here already.
2025-02-01 16:57:18 +09:00
Prajjwal Singh
c6e8ee4514 [ruby/irb] Add copy command (https://github.com/ruby/irb/pull/1044)
Closes https://github.com/ruby/irb/pull/753

https://github.com/ruby/irb/commit/a24ac53d48
2025-01-22 23:08:34 +09: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 Patterson
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
Kouhei Yanagita
edf5a738a3 [ruby/irb] Complete the missing documentation abount the environment
variables
(https://github.com/ruby/irb/pull/1028)

https://github.com/ruby/irb/commit/68f5cf0535
2024-11-19 13:13:20 +00: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
tomoya ishida
c4efd17061 [ruby/irb] Add command line option to select which completor to use
(https://github.com/ruby/irb/pull/754)

* Add command line option to select which completor to use

* Add test for completor argv

https://github.com/ruby/irb/commit/1dec2708c9
2023-11-09 13:15:26 +00: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
Kouhei Yanagita
107acbd9a4 [ruby/irb] Add description of IRB_LANG, IRBRC, and XDG_CONFIG_HOME to man
https://github.com/ruby/irb/commit/564bd91387
2022-10-05 19:20:22 +09:00
Matt Valentine-House
ca85bd818a [ci skip] Improve man page docs around --dump options 2022-06-28 10:10:26 -04:00
aycabta
7732052718 [ruby/irb] Add help about extra doc dir option
https://github.com/ruby/irb/commit/5018f2cb99
2021-10-11 21:12:58 +09:00
aycabta
00cfafc0f5 [ruby/irb] Add doc about "echo on assignment"
https://github.com/ruby/irb/commit/5af637b3c1
2021-09-27 03:23:48 +09:00
aycabta
5c0636bda4 [ruby/irb] Add a space before left paren
https://github.com/ruby/irb/commit/973bac83ff
2021-09-27 03:23:31 +09:00
aycabta
ece4ed0da7 Add --autocomplete / --noautocomplete options 2021-08-30 02:45:13 +09: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
Hiroshi SHIBATA
69ed64949b Track Bundler master(2.3.0.dev) branch at 55634a8af18a52df86c4275d70fa1179118bcc20 2021-01-04 13:14:43 +09:00
Hiroshi SHIBATA
473f9d2df0 Merge prepare version of Bundler 2.2.0 2020-12-08 17:30:02 +09:00