1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Feature #19790] [DOC] Fix the manual page as crash report

Browse Source 
Also add missing `%f` and `%F`.
This commit is contained in:
Nobuyoshi Nakada 2023-08-10 00:13:22 +09:00
parent e2a5f0469c
commit 904413997f
No known key found for this signature in database
GPG Key ID: 3582D74E1FEE4465
1 changed files with 32 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
man/ruby.1
View File

@ -472,7 +472,7 @@ If this switch is given, and no script arguments (script file or
options) are present, Ruby quits immediately. options) are present, Ruby quits immediately.
.Pp .Pp
.It Fl -crash-report Ns = Ns Ar template .It Fl -crash-report Ns = Ns Ar template
Sets the template of path name to save bug report. Sets the template of path name to save crash report.
See See
.Ev RUBY_CRASH_REPORT .Ev RUBY_CRASH_REPORT
environment variable for details. environment variable for details.
@ -652,42 +652,55 @@ Machine stack size used at fiber creation.
default: 262144 or 524288 default: 262144 or 524288
.Pp .Pp
.El .El
.Sh BUG REPORT ENVIRONMENT .Sh CRASH REPORT ENVIRONMENT
.Pp .Pp
.Bl -tag -compact -width "RUBY_CRASH_REPORT" .Bl -tag -compact -width "RUBY_CRASH_REPORT"
.It Ev RUBY_CRASH_REPORT .It Ev RUBY_CRASH_REPORT
The template of path name to save bug report. The template of path name to save crash report.
default: none default: none
.El .El
.Ss Naming bug report files .Ss Naming crash report files
The template can contain % specifiers which are substituted The template can contain
by the following values when a bug report file is created: .Li \fB%\fP
specifiers which are substituted by the following values when a crash
report file is created:
.Pp .Pp
.Bl -hang -compact -width "%NNN" .Bl -hang -compact -width "%NNN"
.It %% .It Li \fB%%\fP
A single % character. A single
.It %e .Li \fB%\fP
character.
.It Li \fB%e\fP
Basename of executable. Basename of executable.
.It %E .It Li \fB%E\fP
Pathname of executable, Pathname of executable,
with slashes (\fB/\fP) replaced by exclamation marks (\fB!\fP). with slashes (\fB/\fP) replaced by exclamation marks (\fB!\fP).
.It %p .It Li \fB%f\fP
Basename of the program name,
.Li "$0" .
.It Li \fB%F\fP
Pathname of the program name,
.Li "$0",
with slashes (\fB/\fP) replaced by exclamation marks (\fB!\fP).
.It Li \fB%p\fP
PID of dumped process. PID of dumped process.
.It %t .It Li \fB%t\fP
Time of dump, expressed as seconds since the Time of dump, expressed as seconds since the
Epoch, 1970-01-01 00:00:00 +0000 (UTC). Epoch, 1970-01-01 00:00:00 +0000 (UTC).
.It %NNN .It Li \fB%NNN\fP
A character code in octal. A character code in octal.
.El .El
.Pp .Pp
A single % at the end of the template is dropped from the A single
core filename, as is the combination of a % followed by any .Li \fB%\fP
character other than those listed above. at the end of the template is dropped from the core filename, as is
All other characters in the template become a literal the combination of a
part of the core filename. .Li \fB%\fP
followed by any character other than those listed above. All other
characters in the template become a literal part of the core filename.
The template may include \(aq/\(aq characters, which are interpreted The template may include \(aq/\(aq characters, which are interpreted
as delimiters for directory names. as delimiters for directory names.
.Ss Piping bug reports to a program .Ss Piping crash reports to a program
If the first character of this file is a pipe symbol (\fB|\fP), If the first character of this file is a pipe symbol (\fB|\fP),
then the remainder of the line is interpreted as the command-line for then the remainder of the line is interpreted as the command-line for
a program (or script) that is to be executed. a program (or script) that is to be executed.