aboutsummaryrefslogtreecommitdiffstats
path: root/lib/mkmf.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/mkmf.rb')
-rw-r--r--lib/mkmf.rb29
1 files changed, 22 insertions, 7 deletions
diff --git a/lib/mkmf.rb b/lib/mkmf.rb
index 88084554f4..1da0e59915 100644
--- a/lib/mkmf.rb
+++ b/lib/mkmf.rb
@@ -1677,13 +1677,28 @@ SRC
$extconf_h = header
end
- # Sets a +target+ name that the user can then use to configure various
- # "with" options with on the command line by using that name. For example,
- # if the target is set to "foo", then the user could use the
- # <code>--with-foo-dir</code> command line option.
- #
- # You may pass along additional "include" or "lib" defaults via the
- # +idefault+ and +ldefault+ parameters, respectively.
+ # call-seq:
+ # dir_config(target)
+ # dir_config(target, prefix)
+ # dir_config(target, idefault, ldefault)
+ #
+ # Sets a +target+ name that the user can then use to configure
+ # various "with" options with on the command line by using that
+ # name. For example, if the target is set to "foo", then the user
+ # could use the <code>--with-foo-dir=prefix</code>,
+ # <code>--with-foo-include=dir</code> and
+ # <code>--with-foo-lib=dir</code> command line options to tell where
+ # to search for header/library files.
+ #
+ # You may pass along additional parameters to specify default
+ # values. If one is given it is taken as default +prefix+, and if
+ # two are given they are taken as "include" and "lib" defaults in
+ # that order.
+ #
+ # In any case, the return value will be an array of determined
+ # "include" and "lib" directories, either of which can be nil if no
+ # corresponding command line option is given when no default value
+ # is specified.
#
# Note that dir_config only adds to the list of places to search for
# libraries and include files. It does not link the libraries into your