Merge pull request #439 from sodabrew/with_rpath

Options to alter or disable rpath

Author: sodabrew

README.md

@@ -32,17 +32,24 @@ By default, the mysql2 gem will try to find a copy of MySQL in this order:
 ### Configuration options
 
 Use these options by `gem install mysql2 -- [--optionA] [--optionB=argument]`.
-The following options are mutually exclusive.
 
 * `--with-mysql-dir[=/path/to/mysqldir]` -
 Specify the directory where MySQL is installed. The mysql2 gem will not use
 `mysql_config`, but will instead look at `mysqldir/lib` and `mysqldir/include`
 for the library and header files.
+This option is mutually exclusive with `--with-mysql-config`.
 
 * `--with-mysql-config[=/path/to/mysql_config]` -
 Specify a path to the `mysql_config` binary provided by your copy of MySQL. The
 mysql2 gem will ask this `mysql_config` binary about the compiler and linker
 arguments needed.
+This option is mutually exclusive with `--with-mysql-dir`.
+
+* `--with-mysql-rpath=/path/to/mysql/lib` / `--without-mysql-rpath` -
+Override the runtime path used to find the MySQL libraries.
+This may be needed if you deploy to a system where these libraries
+are located somewhere different than on your build system.
+This overrides any rpath calculated by default or by the options above.
 
 ### Windows
 First, make sure you have the DevKit installed (http://rubyinstaller.org/downloads/) and its variables

ext/mysql2/extconf.rb

@@ -98,20 +98,32 @@ def asplode lib
   $CFLAGS << gcc_flags
 end
 
-if libdir = rpath_dir[%r{(-L)?(/[^ ]+)}, 2]
-  rpath_flags = " -Wl,-rpath,#{libdir}"
-  if RbConfig::CONFIG["RPATHFLAG"].to_s.empty? && try_link('int main() {return 0;}', rpath_flags)
-    # Usually Ruby sets RPATHFLAG the right way for each system, but not on OS X.
-    warn "-----\nSetting rpath to #{libdir}\n-----"
-    $LDFLAGS << rpath_flags
-  else
-    if RbConfig::CONFIG["RPATHFLAG"].to_s.empty?
-      # If we got here because try_link failed, warn the user
-      warn "-----\nDon't know how to set rpath on your system, if MySQL libraries are not in path mysql2 may not load\n-----"
+case explicit_rpath = with_config('mysql-rpath')
+when true
+  abort "-----\nOption --with-mysql-rpath must have an argument\n-----"
+when false
+  warn "-----\nOption --with-mysql-rpath has been disabled at your request\n-----"
+when String
+  # The user gave us a value so use it
+  rpath_flags = " -Wl,-rpath,#{explicit_rpath}"
+  warn "-----\nSetting mysql rpath to #{explicit_rpath}\n-----"
+  $LDFLAGS << rpath_flags
+else
+  if libdir = rpath_dir[%r{(-L)?(/[^ ]+)}, 2]
+    rpath_flags = " -Wl,-rpath,#{libdir}"
+    if RbConfig::CONFIG["RPATHFLAG"].to_s.empty? && try_link('int main() {return 0;}', rpath_flags)
+      # Usually Ruby sets RPATHFLAG the right way for each system, but not on OS X.
+      warn "-----\nSetting rpath to #{libdir}\n-----"
+      $LDFLAGS << rpath_flags
+    else
+      if RbConfig::CONFIG["RPATHFLAG"].to_s.empty?
+        # If we got here because try_link failed, warn the user
+        warn "-----\nDon't know how to set rpath on your system, if MySQL libraries are not in path mysql2 may not load\n-----"
+      end
+      # Make sure that LIBPATH gets set if we didn't explicitly set the rpath.
+      warn "-----\nSetting libpath to #{libdir}\n-----"
+      $LIBPATH << libdir unless $LIBPATH.include?(libdir)
     end
-    # Make sure that LIBPATH gets set if we didn't explicitly set the rpath.
-    warn "-----\nSetting libpath to #{libdir}\n-----"
-    $LIBPATH << libdir unless $LIBPATH.include?(libdir)
   end
 end