summaryrefslogtreecommitdiff
path: root/ruby.c
diff options
context:
space:
mode:
authorknu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-09-02 05:42:02 +0000
committerknu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-09-02 05:42:02 +0000
commit1b4addb445f8485aa5d3769b3500689188b31901 (patch)
treec83d9d61f5667b352c3b5d90f0bae5e7c31df3b0 /ruby.c
parent01983c97a96a731b459dab7bab9c34a0468c7caf (diff)
Process#setproctitle,argv0: Fix and improve rdoc.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42771 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ruby.c')
-rw-r--r--ruby.c12
1 files changed, 10 insertions, 2 deletions
diff --git a/ruby.c b/ruby.c
index 9e5a516..6723d20 100644
--- a/ruby.c
+++ b/ruby.c
@@ -1787,6 +1787,9 @@ rb_load_file_str(VALUE fname_v)
*
* Returns the name of the script being executed. The value is not
* affected by assigning a new value to $0.
+ *
+ * This method first appeared in Ruby 2.1 to serve as a global
+ * variable free means to get the script name.
*/
static VALUE
@@ -1799,12 +1802,17 @@ proc_argv0(VALUE process)
* call-seq:
* Process.setproctitle(string) -> string
*
- * Returns the process title that appears on the ps(1) command. Not
- * necessarily effective on all platforms.
+ * Sets the process title that appears on the ps(1) command. Not
+ * necessarily effective on all platforms. No exception will be
+ * raised regardless of the result, nor will NotImplementedError be
+ * raised even if the platform does not support the feature.
*
* Calling this method does not affect the value of $0.
*
* Process.setproctitle('myapp: worker #%d' % worker_id)
+ *
+ * This method first appeared in Ruby 2.1 to serve as a global
+ * variable free means to change the process title.
*/
static VALUE