summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-07-26 04:11:27 +0000
committerzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-07-26 04:11:27 +0000
commit5cbfd7509c1d7a67a2ec972c37d5d641eb021f8f (patch)
treeb52edc34f627c2bcaab35f2cce4e248e166f5724
parent8948280c67072f652eebc31bc3a2f3fb86bcca5f (diff)
* ext/fiddle/lib/fiddle.rb: [DOC] Document Fiddle.dlopen(nil)
* ext/fiddle/handle.c: [DOC] Document Fiddle::Handle.new(nil) git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42184 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r--ChangeLog5
-rw-r--r--ext/fiddle/handle.c11
-rw-r--r--ext/fiddle/lib/fiddle.rb5
3 files changed, 18 insertions, 3 deletions
diff --git a/ChangeLog b/ChangeLog
index 8f8862805ce..495b89b0c45 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Fri Jul 26 13:08:53 2013 Zachary Scott <e@zzak.io>
+
+ * ext/fiddle/lib/fiddle.rb: [DOC] Document Fiddle.dlopen(nil)
+ * ext/fiddle/handle.c: [DOC] Document Fiddle::Handle.new(nil)
+
Fri Jul 26 13:04:15 2013 Nobuyoshi Nakada <nobu@ruby-lang.org>
* load.c (rb_load_internal): use rb_load_file_str() to keep path
diff --git a/ext/fiddle/handle.c b/ext/fiddle/handle.c
index 832ff3319a0..357ff0510c3 100644
--- a/ext/fiddle/handle.c
+++ b/ext/fiddle/handle.c
@@ -113,10 +113,15 @@ predefined_fiddle_handle(void *handle)
/*
* call-seq:
- * new(lib = nil, flags = Fiddle::RTLD_LAZY | Fiddle::RTLD_GLOBAL)
+ * new(library = nil, flags = Fiddle::RTLD_LAZY | Fiddle::RTLD_GLOBAL)
+ *
+ * Create a new handler that opens +library+ with +flags+.
+ *
+ * If no +library+ is specified or +nil+ is given, RTLD_DEFAULT is used, which
+ * usually means +libc+.
+ *
+ * libc = Fiddle::Handle.new
*
- * Create a new handler that opens library named +lib+ with +flags+. If no
- * library is specified, RTLD_DEFAULT is used.
*/
static VALUE
rb_fiddle_handle_initialize(int argc, VALUE argv[], VALUE self)
diff --git a/ext/fiddle/lib/fiddle.rb b/ext/fiddle/lib/fiddle.rb
index c8a7ef1b05c..3a9b5d5bffa 100644
--- a/ext/fiddle/lib/fiddle.rb
+++ b/ext/fiddle/lib/fiddle.rb
@@ -32,6 +32,11 @@ module Fiddle
# Creates a new handler that opens +library+, and returns an instance of
# Fiddle::Handle.
#
+ # If +nil+ is given for the +library+, Fiddle::Handle::DEFAULT is used, which
+ # usually means +libc+.
+ #
+ # libc = Fiddle.dlopen(nil)
+ #
# See Fiddle::Handle.new for more.
def dlopen library
Fiddle::Handle.new library