Skip to content

Commit 38de389

Browse files
authored
README.win32: Formatting
Ease redability with text formatting using Pod's commands
1 parent 798066b commit 38de389

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.win32

Lines changed: 12 additions & 12 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
@@ -59,7 +59,7 @@ Delivers gcc toolchain building 32-bit executables (which can be used both 32 an
5959

6060
Delivers gcc toolchain targeting both 64-bit Windows and 32-bit Windows
6161
platforms (despite the project name "mingw-w64" they are not only 64-bit
62-
oriented). They deliver the native gcc compilers and cross-compilers
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
@@ -197,7 +197,7 @@ The defaults in the C<gmake> makefile are set up to build with MinGW/gcc.
197197
=item *
198198

199199
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
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
@@ -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.
@@ -272,7 +272,7 @@ 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

0 commit comments

Comments
 (0)