Skip to content

Commit 90ef28f

Browse files
committed
[DOC] Tweaks for windows.md
1 parent 4f467c3 commit 90ef28f

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

doc/windows.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,16 @@ make
7272

7373
**Note** building ruby requires following commands.
7474

75-
* nmake
76-
* cl
77-
* ml
78-
* lib
79-
* dumpbin
75+
* `nmake`
76+
* `cl`
77+
* `ml`
78+
* `lib`
79+
* `dumpbin`
8080

8181
4. If you want to build from GIT source, following commands are required.
82-
* git
83-
* sed
84-
* ruby 3.0 or later
82+
* `git`
83+
* `sed`
84+
* `ruby` 3.0 or later
8585

8686
You can use [scoop](https://scoop.sh/) to install them like:
8787

@@ -104,21 +104,23 @@ make
104104
105105
1. Execute `win32\configure.bat` on your build directory.
106106
You can specify the target platform as an argument.
107-
For example, run `configure --target=i686-mswin32`
107+
For example, run `configure --target=i686-mswin32`.
108108
You can also specify the install directory.
109-
For example, run `configure --prefix=<install_directory>`
109+
For example, run `configure --prefix=<install_directory>`.
110110
Default of the install directory is `/usr` .
111111
112-
2. If you want to change the name of the executable files and the DLL
113-
file, you can specify `--program-prefix` and `--program-suffix`,
114-
like `win32\configure.bat --program-suffix=-$(MAJOR)$(MINOR)`.
112+
2. If you want to append to the executable and DLL file names,
113+
specify `--program-prefix` and `--program-suffix`, like
114+
`win32\configure.bat --program-suffix=-$(MAJOR)$(MINOR)`.
115115
116-
Also `--install-name` and `--so-name` options affect the whole
117-
name executable files and the DLL file respectively, like
118-
`win32\configure.bat --install-name=$(RUBY_BASE_NAME)-$(MAJOR)$(MINOR)`.
116+
Also, the `--install-name` and `--so-name` options specify the
117+
exact base names of the executable and DLL files, respectively,
118+
like `win32\configure.bat --install-name=$(RUBY_BASE_NAME)-$(MAJOR)$(MINOR)`.
119119
120-
And add _RUBYW_INSTALL_NAME_ to change the name of the
121-
executable without console window if also you want.
120+
By default, the name for the executable without a console window
121+
is generated from the _RUBY_INSTALL_NAME_ specified as above by
122+
replacing `ruby` with `rubyw`. If you want to make it different
123+
more, modify _RUBYW_INSTALL_NAME_ directly in the Makefile.
122124
123125
3. You need specify vcpkg directory to use `--with-opt-dir`
124126
option like `win32\configure.bat --with-opt-dir=vcpkg_installed\x64-windows`
@@ -127,8 +129,8 @@ make
127129
128130
5. Run `nmake`
129131
130-
6. Run `nmake prepare-vcpkg` if you need to copy
131-
vcpkg installed libraries like `libssl-3-x64.dll` to the build directory.
132+
6. Run `nmake prepare-vcpkg` if you need to copy vcpkg installed
133+
libraries like `libssl-3-x64.dll` to the build directory.
132134
133135
7. Run `nmake check`
134136

0 commit comments

Comments
 (0)