Windows¶ ↑
Ruby supports a few native build platforms for Windows.
-
mswin: Build using Microsoft Visual C++ compiler with vcruntimeXXX.dll
-
mingw-msvcrt: Build using compiler for Mingw with msvcrtXX.dll
-
mingw-ucrt: Build using compiler for Mingw with Windows Universal CRT
Building Ruby using Mingw with UCRT¶ ↑
The easiest build environment is just a standard RubyInstaller-Devkit installation and git-for-windows. You might like to use VSCode as an editor.
Build examples¶ ↑
Ruby core development can be done either in Windows cmd
like:
ridk enable ucrt64 pacman -S --needed %MINGW_PACKAGE_PREFIX%-openssl %MINGW_PACKAGE_PREFIX%-libyaml %MINGW_PACKAGE_PREFIX%-libffi cd c:\ mkdir work cd work git clone https://github.com/ruby/ruby cd c:\work\ruby sh autogen.sh sh configure -C --disable-install-doc make
or in MSYS2 bash
like:
ridk enable ucrt64 bash pacman -S --needed $MINGW_PACKAGE_PREFIX-openssl $MINGW_PACKAGE_PREFIX-libyaml $MINGW_PACKAGE_PREFIX-libffi cd /c/ mkdir work cd work git clone https://github.com/ruby/ruby cd ruby ./autogen.sh ./configure -C --disable-install-doc make
Building Ruby using Visual C++¶ ↑
Requirement¶ ↑
-
Windows 10/Windows Server 2016 or later.
-
Visual C++ 14.0 (2015) or later.
Note if you want to build x64 version, use native compiler for x64.
-
Please set environment variable
INCLUDE
,LIB
,PATH
to run required commands properly from the command line. These are set properly byvcvarall*.bat
usually.Note building ruby requires following commands.
-
nmake
-
cl
-
ml
-
lib
-
dumpbin
-
-
If you want to build from GIT source, following commands are required.
-
git
-
sed
-
ruby
3.0 or later
You can use scoop to install them like:
scoop install git sed ruby
-
-
You need to install required libraries using vcpkg on directory of ruby repository like:
vcpkg --triplet x64-windows install
-
Enable Command Extension of your command line. It's the default behavior of
cmd.exe
. If you want to enable it explicitly, runcmd.exe
with/E:ON
option.
How to compile and install¶ ↑
-
Execute
win32\configure.bat
on your build directory. You can specify the target platform as an argument. For example, runconfigure --target=i686-mswin32
. You can also specify the install directory. For example, runconfigure --prefix=<install_directory>
. Default of the install directory is/usr
. -
If you want to append to the executable and DLL file names, specify
--program-prefix
and--program-suffix
, likewin32\configure.bat --program-suffix=-$(MAJOR)$(MINOR)
.Also, the
--install-name
and--so-name
options specify the exact base names of the executable and DLL files, respectively, likewin32\configure.bat --install-name=$(RUBY_BASE_NAME)-$(MAJOR)$(MINOR)
.By default, the name for the executable without a console window is generated from the RUBY_INSTALL_NAME specified as above by replacing
ruby
withrubyw
. If you want to make it different more, modify RUBYW_INSTALL_NAME directly in the Makefile. -
You need specify vcpkg directory to use
--with-opt-dir
option likewin32\configure.bat --with-opt-dir=vcpkg_installed\x64-windows
-
Run
nmake up
if you are building from GIT source. -
Run
nmake
-
Run
nmake prepare-vcpkg
if you need to copy vcpkg installed libraries likelibssl-3-x64.dll
to the build directory. -
Run
nmake check
-
Run
nmake install
Build examples¶ ↑
-
Build on the ruby source directory.
ruby source directory: C:\ruby build directory: C:\ruby install directory: C:\usr\local
C: cd \ruby win32\configure --prefix=/usr/local nmake nmake check nmake install
-
Build on the relative directory from the ruby source directory.
ruby source directory: C:\ruby build directory: C:\ruby\mswin32 install directory: C:\usr\local
C: cd \ruby mkdir mswin32 cd mswin32 ..\win32\configure --prefix=/usr/local nmake nmake check nmake install
-
Build on the different drive.
ruby source directory: C:\src\ruby build directory: D:\build\ruby install directory: C:\usr\local
D: cd D:\build\ruby C:\src\ruby\win32\configure --prefix=/usr/local nmake nmake check nmake install DESTDIR=C:
-
Build x64 version (requires native x64 VC++ compiler)
ruby source directory: C:\ruby build directory: C:\ruby install directory: C:\usr\local
C: cd \ruby win32\configure --prefix=/usr/local --target=x64-mswin64 nmake nmake check nmake install
Bugs¶ ↑
You can NOT use a path name that contains any white space characters as the ruby source directory, this restriction comes from the behavior of !INCLUDE
directives of NMAKE
.
You can build ruby in any directory including the source directory, except win32
directory in the source directory. This is restriction originating in the path search method of NMAKE
.
Dependency management¶ ↑
Ruby uses vcpkg to manage dependencies on mswin platform.
You can update and install it under the build directory like:
nmake update-vcpkg # Update baseline version of vcpkg nmake install-vcpkg # Install vcpkg from build directory
Icons¶ ↑
Any icon files(*.ico
) in the build directory, directories specified with icondirs make variable and win32
directory under the ruby source directory will be included in DLL or executable files, according to their base names. $(RUBY_INSTALL_NAME).ico or ruby.ico –> $(RUBY_INSTALL_NAME).exe $(RUBYW_INSTALL_NAME).ico or rubyw.ico –> $(RUBYW_INSTALL_NAME).exe the others –> $(RUBY_SO_NAME).dll
Although no icons are distributed with the ruby source, you can use anything you like. You will be able to find many images by search engines. For example, followings are made from Ruby logo kit:
-
Small favicon in the official site