aboutsummaryrefslogtreecommitdiffstats
path: root/process.c
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2023-09-05 11:53:11 -0500
committerGitHub <noreply@github.com>2023-09-05 12:53:11 -0400
commita17a1cd53573048ef3574fd105c297fadef9e934 (patch)
treec33e3fce9aaa609a365671ca203bd304d5ed2143 /process.c
parent88b25294b0e8d75f7901444bc5b2dc9e79411bdf (diff)
downloadruby-a17a1cd53573048ef3574fd105c297fadef9e934.tar.gz
[DOC] Fix for RDoc for Process.kill (#8370)
Diffstat (limited to 'process.c')
-rw-r--r--process.c46
1 files changed, 8 insertions, 38 deletions
diff --git a/process.c b/process.c
index 1360d57573..acb74c2d47 100644
--- a/process.c
+++ b/process.c
@@ -8682,53 +8682,23 @@ get_PROCESS_ID(ID _x, VALUE *_y)
* with prefixed <tt>'-'</tt>,
* each process group with group ID +id+ is signalled.
*
- * The actual signal values are platform dependent, an example of
- * signal names which are supported on many platforms are:
- *
- * - +SIGHUP+: Hang up controlling terminal or process.
- * - +SIGINT+: \Interrupt from keyboard, Ctrl-C by default in general.
- * - +SIGQUIT+: Quit from keyboard, Ctrl-\ by default in general.
- * - +SIGILL+: Illegal instruction.
- * - +SIGTRAP+: Breakpoint for debugging.
- * - +SIGIOT+: Abnormal termination.
- * - +SIGBUS+: Bus error.
- * - +SIGFPE+: Floating-point exception.
- * - +SIGKILL+: Forced-process termination.
- * - +SIGUSR1+: Available to processes.
- * - +SIGSEGV+: Invalid memory reference.
- * - +SIGUSR2+: Available to processes.
- * - +SIGPIPE+: Write to pipe with no readers.
- * - +SIGALRM+: Real-timer clock.
- * - +SIGTERM+: \Process termination.
- * - +SIGCHLD+: Child process stopped or terminated or got a signal if traced.
- * - +SIGCONT+: Resume execution, if stopped.
- * - +SIGSTOP+: Stop process execution, Ctrl-Z by default in general.
- * - +SIGTSTP+: Stop process issued from tty.
- * - +SIGTTIN+: Background process requires input.
- * - +SIGTTOU+: Background process requires output.
- * - +SIGURG+: Urgent condition on socket.
- * - +SIGXCPU+: CPU time limit exceeded.
- * - +SIGXFSZ+: File size limit exceeded.
- * - +SIGVTALRM+: Virtual timer clock.
- * - +SIGPROF+: Profile timer clock.
- * - +SIGWINCH+: Window resizing.
- * - +SIGPOLL+: I/O now possible.
- * - +SIGPWR+: Power supply failure.
- * - +SIGSYS+, +SIGUNUSED+: Bad system call.
- *
- * Use Signal.list to see which signals are supported, and the actual
- * values.
+ * Use method Signal.list to see which signals are supported
+ * by Ruby on the underlying platform;
+ * the method returns a hash of the string names
+ * and non-negative integer values of the supported signals.
+ * The size and content of the returned hash varies widely
+ * among platforms.
*
* Additionally, signal +0+ is useful to determine if the process exists.
*
* Example:
*
* pid = fork do
- * Signal.trap("HUP") { puts "Ouch!"; exit }
+ * Signal.trap('HUP') { puts 'Ouch!'; exit }
* # ... do some work ...
* end
* # ...
- * Process.kill("HUP", pid)
+ * Process.kill('HUP', pid)
* Process.wait
*
* Output: