diff options
author | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2014-04-08 13:55:57 +0000 |
---|---|---|
committer | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2014-04-08 13:55:57 +0000 |
commit | 0192e15b4ce61e38a239f3a3ae9c19e1d6efaa21 (patch) | |
tree | 8c88eb5829171befb83f53346b4341e8560e95bd /lib/mkmf.rb | |
parent | d37460d75b61ff2dfcd0c88204cdd12932c034c5 (diff) | |
download | ruby-0192e15b4ce61e38a239f3a3ae9c19e1d6efaa21.tar.gz |
* lib/mkmf.rb (MakeMakefile#dir_config): Improve documentation.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@45533 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/mkmf.rb')
-rw-r--r-- | lib/mkmf.rb | 29 |
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 |