Skip to content

Commit fe13354

Browse files
authored
README.win32: Formatting-only
Enhance readability by using Pod commands for text formatting
1 parent bf1aacf commit fe13354

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

README.win32

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ These are instructions for building Perl under Windows 7 and later.
1414

1515
=head1 DESCRIPTION
1616

17-
Before you start, you should glance through the README file
17+
Before you start, you should glance through the F<README> file
1818
found in the top-level directory to which the Perl distribution
1919
was extracted. Make sure you read and understand the terms under
2020
which this software is being distributed.
2121

2222
Also make sure you read L</BUGS AND CAVEATS> below for the
2323
known limitations of this port.
2424

25-
The INSTALL file in the perl top-level has much information that is
25+
The F<INSTALL> file in the perl top-level has much information that is
2626
only relevant to people building Perl on Unix-like systems. In
2727
particular, you can safely ignore any information that talks about
28-
"Configure".
28+
F<Configure>.
2929

3030
You may also want to look at one other option for building a perl that
31-
will work on Windows: the README.cygwin file, which give a different
31+
will work on Windows: the F<README.cygwin> file, which give a different
3232
set of rules to build a perl for Windows. This method will probably
3333
enable you to build a more Unix-compatible perl, but you will also
3434
need to download and use various other build-time and run-time support
@@ -43,23 +43,23 @@ following compilers on the Intel x86 and x86_64 architectures:
4343

4444
Microsoft Visual C++ Visual C++ 2015 (version 14.0) or later
4545
Intel C++ Compiler (experimental)
46-
Gcc by mingw.org gcc version 3.4.5-5.3.0
47-
Gcc by mingw-w64.org gcc version 4.4.3 or later
46+
GCC by mingw.org GCC version 3.4.5-5.3.0
47+
GCC by mingw-w64.org GCC version 4.4.3 or later
4848

4949
Note that the last two of these are actually competing projects both
50-
delivering complete gcc toolchain for MS Windows:
50+
delivering complete GCC toolchain for MS Windows:
5151

5252
=over 4
5353

5454
=item L<https://osdn.net/projects/mingw/>
5555

56-
Delivers gcc toolchain building 32-bit executables (which can be used both 32 and 64 bit Windows platforms)
56+
Delivers GCC toolchain building 32-bit executables (which can be used both 32 and 64 bit Windows platforms)
5757

5858
=item L<https://mingw-w64.org>
5959

60-
Delivers gcc toolchain targeting both 64-bit Windows and 32-bit Windows
61-
platforms (despite the project name "mingw-w64" they are not only 64-bit
62-
oriented). They deliver the native gcc compilers and cross-compilers
60+
Delivers GCC toolchain targeting both 64-bit Windows and 32-bit Windows
61+
platforms (despite the project name I<mingw-w64> they are not only 64-bit
62+
oriented). They deliver the native GCC compilers and cross-compilers
6363
that are also supported by perl's makefile.
6464

6565
=back
@@ -74,9 +74,9 @@ down compiler (no java, or gfortran) suitable for building perl available at:
7474
L<https://strawberryperl.com/package/kmx/64_gcctoolchain/>
7575

7676
NOTE: If you're using a 32-bit compiler to build perl on a 64-bit Windows
77-
operating system, then you should set the WIN64 environment variable to "undef".
78-
Also, the trimmed down compiler only passes tests when USE_ITHREADS *= define
79-
(as opposed to undef) and when the CFG *= Debug line is commented out.
77+
operating system, then you should set the C<WIN64> environment variable to C<undef>.
78+
Also, the trimmed down compiler only passes tests when C<USE_ITHREADS *= define>
79+
(as opposed to C<undef>) and when the C<CFG *= Debug> line is commented out.
8080

8181
This port fully supports MakeMaker (the set of modules that
8282
is used to build extensions to perl). Therefore, you should be
@@ -91,8 +91,8 @@ See L</Usage Hints for Perl on Windows> below for general hints about this.
9191

9292
You need a "make" program to build the sources. If you are using
9393
Visual C++, you can use nmake supplied with Visual C++.
94-
You may also use gmake instead of nmake. Builds using gcc need
95-
gmake. nmake is not supported for gcc builds. Parallel building is only
94+
You may also use gmake instead of nmake. Builds using GCC need
95+
gmake. nmake is not supported for GCC builds. Parallel building is only
9696
supported with gmake, not nmake.
9797

9898
=item Command Shell
@@ -116,7 +116,7 @@ compiler product, these batch files will already be in your C<PATH>
116116
environment variable so you may just type them without an absolute path into
117117
your console. If you need to find the absolute path to the batch file, it is
118118
usually found somewhere like
119-
C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC.
119+
F<C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC>.
120120
With some newer Microsoft C products (released after ~2004), the installer will
121121
put a shortcut in the start menu to launch a new console window with the
122122
console already set up for your target architecture (x86-32 or x86-64 or IA64).
@@ -151,14 +151,14 @@ This is also referred to as I<Build Tools for Visual Studio>.
151151

152152
=item GCC
153153

154-
Perl can be compiled with gcc from MinGW (version 3.4.5 or later) or from
154+
Perl can be compiled with GCC from MinGW (version 3.4.5 or later) or from
155155
MinGW64 (version 4.4.3 or later). It can be downloaded here:
156156

157157
L<https://osdn.net/projects/mingw/>
158158
L<https://www.mingw-w64.org/>
159159

160-
You also need gmake. Usually it comes with MinGW but its executable may have
161-
a different name, such as mingw32-make.exe.
160+
You also need C<gmake>. Usually it comes with MinGW but its executable may have
161+
a different name, such as F<mingw32-make.exe>.
162162

163163
Note that the MinGW build currently fails with version 6.3.0 or later.
164164

@@ -192,12 +192,12 @@ Make sure you are in the F<win32> subdirectory under the perl toplevel.
192192
This directory contains a F<Makefile> that will work with
193193
versions of C<nmake> that come with Visual C++, and
194194
a GNU make F<GNUmakefile> that will work for all supported compilers.
195-
The defaults in the C<gmake> makefile are set up to build with MinGW/gcc.
195+
The defaults in the C<gmake> makefile are set up to build with MinGW/GCC.
196196

197197
=item *
198198

199-
Edit the F<GNUmakefile> (or F<Makefile>, if you're using F<nmake>) and change
200-
the values of I<INST_DRV> and C<INST_TOP>. You can also enable various build
199+
Edit the F<GNUmakefile> (or F<Makefile>, if you're using C<nmake>) and change
200+
the values of C<INST_DRV> and C<INST_TOP>. You can also enable various build
201201
flags. These are explained in the makefiles.
202202

203203
Note that it is generally not a good idea to try to build a C<perl> with
@@ -213,7 +213,7 @@ should be the directory that contains the F<bin>, F<include> and
213213
F<lib> directories.
214214

215215
If building with the cross-compiler provided by
216-
mingw-w64.org you'll need to uncomment the line that sets
216+
L<https://mingw-w64.org> you'll need to uncomment the line that sets
217217
C<GCCCROSS> in the F<GNUmakefile>. Do this only if it's the cross-compiler,
218218
ie. only if the F<bin> folder doesn't contain a F<gcc.exe>. (The cross-compiler
219219
does not provide a F<gcc.exe>, F<g++.exe>, F<ar.exe>, etc. Instead, all of these
@@ -253,7 +253,7 @@ is the most commonly launched program during the build and later testing.
253253

254254
=head2 Testing Perl on Windows
255255

256-
Type "gmake test" (or "nmake test"). This will run most
256+
Type C<gmake test> (or C<nmake test>). This will run most
257257
of the tests from the testsuite (many tests will be skipped).
258258

259259
There should be no test failures.
@@ -263,16 +263,16 @@ may crash (after all its tests have passed). This is due to a regression in the
263263
Universal CRT introduced in the Windows 10 April 2018 Update, and will be fixed
264264
in the May 2019 Update, as explained here: L<https://developercommunity.visualstudio.com/content/problem/519486/setlocalelc-numeric-iso-latin-16-fails-then-succee.html>.
265265

266-
If you build with certain versions (e.g. 4.8.1) of gcc from mingw then
267-
F<ext/POSIX/t/time.t> may fail test 17 due to a known bug in those gcc builds:
266+
If you build with certain versions (e.g. 4.8.1) of GCC from MinGW then
267+
F<ext/POSIX/t/time.t> may fail test 17 due to a known bug in those GCC builds:
268268
see L<https://sourceforge.net/p/mingw/bugs/2152/>.
269269

270270
Some test failures may occur if you use a command shell other than the
271271
native "cmd.exe", or if you are building from a path that contains
272272
spaces. So don't do that.
273273

274274
If you are running the tests from a emacs shell window, you may see
275-
failures in op/stat.t. Run "gmake test-notty" in that case.
275+
failures in F<op/stat.t>. Run C<gmake test-notty> in that case.
276276

277277
Furthermore, you should make sure that during C<make test> you do not
278278
have any GNU tool packages in your path: some toolkits like Unixutils
@@ -291,7 +291,7 @@ Please report any other failures as described under L</BUGS AND CAVEATS>.
291291

292292
=head2 Installation of Perl on Windows
293293

294-
Type "gmake install" ("nmake install"). This will
294+
Type C<gmake install> (C<nmake install>). This will
295295
put the newly built perl and the libraries under whatever C<INST_TOP>
296296
points to in the Makefile. It will also install the pod documentation
297297
under C<$INST_TOP\$INST_VER\lib\pod> and HTML versions of the same
@@ -770,7 +770,7 @@ and borrowed from the Hip Communications port that was available
770770
at the time. Various people have made numerous and sundry hacks
771771
since then.
772772

773-
GCC/mingw32 support was added in 5.005 (Nick Ing-Simmons).
773+
GCC/MinGW32 support was added in 5.005 (Nick Ing-Simmons).
774774

775775
Support for PERL_OBJECT was added in 5.005 (ActiveState Tool Corp).
776776

0 commit comments

Comments
 (0)