X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/d67e180c79c65d7f57c566e833b50b24b5de336d..6987f4434e4dfee71506125954ee1ae41c46f1cb:/README.win32 diff --git a/README.win32 b/README.win32 index 2a8651a..73d74bd 100644 --- a/README.win32 +++ b/README.win32 @@ -17,7 +17,7 @@ found in the top-level directory to which the Perl distribution was extracted. Make sure you read and understand the terms under which this software is being distributed. -Also make sure you read L below for the +Also make sure you read L below for the known limitations of this port. The INSTALL file in the perl top-level has much information that is @@ -42,6 +42,7 @@ following compilers on the Intel x86 architecture: Microsoft Visual C++ version 6.0 or later Intel C++ Compiler (experimental) Gcc by mingw.org gcc version 3.4.5 or later + with runtime < 3.21 Gcc by mingw-w64.org gcc version 4.4.3 or later Note that the last two of these are actually competing projects both @@ -63,17 +64,17 @@ that are also supported by perl's makefile. =back The Microsoft Visual C++ compilers are also now being given away free. They are -available as "Visual C++ Toolkit 2003" or "Visual C++ 2005-2013 Express -Edition" (and also as part of the ".NET Framework SDK") and are the same -compilers that ship with "Visual C++ .NET 2003 Professional" or "Visual C++ -2005-2013 Professional" respectively. +available as "Visual C++ Toolkit 2003" or "Visual C++ 2005-2019 Express [or +Community, from 2017] Edition" (and also as part of the ".NET Framework SDK") +and are the same compilers that ship with "Visual C++ .NET 2003 Professional" +or "Visual C++ 2005-2019 Professional" respectively. This port can also be built on IA64/AMD64 using: Microsoft Platform SDK Nov 2001 (64-bit compiler and tools) MinGW64 compiler (gcc version 4.4.3 or later) -The Windows SDK can be downloaded from L. +The Windows SDK can be downloaded from L. The MinGW64 compiler is available at L. The latter is actually a cross-compiler targeting Win64. There's also a trimmed down compiler (no java, or gfortran) suitable for building perl available at: @@ -87,7 +88,7 @@ Also, the trimmed down compiler only passes tests when USE_ITHREADS *= define This port fully supports MakeMaker (the set of modules that is used to build extensions to perl). Therefore, you should be able to build and install most extensions found in the CPAN sites. -See L below for general hints about this. +See L below for general hints about this. =head2 Setting Up Perl on Windows @@ -97,18 +98,18 @@ See L below for general hints about this. You need a "make" program to build the sources. If you are using Visual C++ or the Windows SDK tools, you can use nmake supplied with Visual C++ -or Windows SDK. You may also use, for Visual C++ or Windows SDK, dmake instead -of nmake. dmake is open source software, but is not included with Visual C++ or -Windows SDK. Builds using gcc need dmake or gmake. nmake is not supported for -gcc builds. gmake only supports gcc builds, not any other compiler. -Parallel building is only supported with dmake with any compiler. It is -recommended to use dmake 4.13 or newer for parallel building. Older dmakes, -in parallel mode, have very high CPU usage and pound the disk/filing system -with duplicate I/O calls in an aggressive polling loop. +or Windows SDK. You may also use, for Visual C++ or Windows SDK, dmake or gmake +instead of nmake. dmake is open source software, but is not included with +Visual C++ or Windows SDK. Builds using gcc need dmake or gmake. nmake is not +supported for gcc builds. Parallel building is only supported with dmake and +gmake, not nmake. When using dmake it is recommended to use dmake 4.13 or newer +for parallel building. Older dmakes, in parallel mode, have very high CPU usage +and pound the disk/filing system with duplicate I/O calls in an aggressive +polling loop. A port of dmake for Windows is available from: -L +L Fetch and install dmake somewhere on your path. @@ -124,41 +125,43 @@ build usually works in this circumstance, but some tests will fail. =item Microsoft Visual C++ -The nmake that comes with Visual C++ will suffice for building. Visual C -requires that certain things be set up in the console before Visual C will -sucessfully run. To make a console box be able to run the C compiler, you will -need to beforehand, run the C file to compile for x86-32 and for -x86-64 C or C. On a typical install of a -Microsoft C compiler product, these batch files will already be in your C +The nmake that comes with Visual C++ will suffice for building. Visual C++ +requires that certain things be set up in the console before Visual C++ will +successfully run. To make a console box be able to run the C compiler, you will +need to beforehand, run C to compile for x86-32 and for +x86-64 C. On a typical install of a Microsoft C++ +compiler product, these batch files will already be in your C environment variable so you may just type them without an absolute path into your console. If you need to find the absolute path to the batch file, it is -usually found somewhere like C:\Program Files\Microsoft Visual Studio\VC98\Bin. -With some newer Micrsoft C products (released after ~2004), the installer will +usually found somewhere like +C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC. +With some newer Microsoft C products (released after ~2004), the installer will put a shortcut in the start menu to launch a new console window with the console already set up for your target architecture (x86-32 or x86-64 or IA64). With the newer compilers, you may also use the older batch files if you choose so. -=item Microsoft Visual C++ 2008-2013 Express Edition +=item Microsoft Visual C++ 2008-2019 Express/Community Edition -These free versions of Visual C++ 2008-2013 Professional contain the same +These free versions of Visual C++ 2008-2019 Professional contain the same compilers and linkers that ship with the full versions, and also contain everything necessary to build Perl, rather than requiring a separate download of the Windows SDK like previous versions did. These packages can be downloaded by searching in the Download Center at -L. (Providing exact +L. (Providing exact links to these packages has proven a pointless task because the links keep on changing so often.) -Install Visual C++ 2008-2013 Express, then setup your environment using, e.g. +Install Visual C++ 2008-2019 Express/Community, then setup your environment +using, e.g. C:\Program Files\Microsoft Visual Studio 12.0\Common7\Tools\vsvars32.bat (assuming the default installation location was chosen). Perl should now build using the win32/Makefile. You will need to edit that -file to set CCTYPE to one of MSVC90FREE-MSVC120FREE first. +file to set CCTYPE to one of MSVC90-MSVC142 first. =item Microsoft Visual C++ 2005 Express Edition @@ -200,7 +203,7 @@ while the latest versions install into version-specific locations such as Perl should now build using the win32/Makefile. You will need to edit that file to set - CCTYPE = MSVC80FREE + CCTYPE = MSVC80 and to set CCHOME, CCINCDIR and CCLIBDIR as per the environment setup above. @@ -218,7 +221,7 @@ Framework Redistributable" to be installed first. This can be downloaded and installed separately, but is included in the "Visual C++ Toolkit 2003" anyway. These packages can all be downloaded by searching in the Download Center at -L. (Providing exact +L. (Providing exact links to these packages has proven a pointless task because the links keep on changing so often.) @@ -311,21 +314,28 @@ The nmake that comes with the Platform SDK will suffice for building Perl. Make sure you are building within one of the "Build Environment" shells available after you install the Platform SDK from the Start Menu. -=item MinGW release 3 with gcc +=item GCC -Perl can be compiled with gcc from MinGW release 3 and later (using gcc 3.4.5 -and later). It can be downloaded here: +Perl can be compiled with gcc from MinGW (version 3.4.5 or later) or from +MinGW64 (version 4.4.3 or later). It can be downloaded here: L +L + +You also need dmake or gmake. See L above on how to get it. -You also need dmake. See L above on how to get it. +Note that the MinGW build currently requires a MinGW runtime version earlier +than 3.21 (check __MINGW32_MAJOR_VERSION and __MINGW32_MINOR_VERSION). + +Note also that the C++ mode build currently fails with MinGW 3.4.5 and 4.7.2 +or later, and with MinGW64 64-bit 6.3.0 or later. =item Intel C++ Compiler Experimental support for using Intel C++ Compiler has been added. Edit win32/Makefile and pick the correct CCTYPE for the Visual C that Intel C was installed into. Also uncomment __ICC to enable Intel C on Visual C support. -To set up the build enviroment, from the Start Menu run +To set up the build environment, from the Start Menu run IA-32 Visual Studio 20__ mode or Intel 64 Visual Studio 20__ mode as appropriate. Then run nmake as usually in that prompt box. @@ -346,14 +356,15 @@ unlike GCC. Make sure you are in the "win32" subdirectory under the perl toplevel. This directory contains a "Makefile" that will work with versions of nmake that come with Visual C++ or the Windows SDK, and -a dmake "makefile.mk" that will work for all supported compilers. The -defaults in the dmake makefile are setup to build using MinGW/gcc. +a GNU make "GNUmakefile" or dmake "makefile.mk" that will work for all +supported compilers. The defaults in the gmake and dmake makefile are +setup to build using MinGW/gcc. =item * -Edit the makefile.mk (or Makefile, if you're using nmake) and change -the values of INST_DRV and INST_TOP. You can also enable various -build flags. These are explained in the makefiles. +Edit the GNUmakefile, makefile.mk (or Makefile, if you're using nmake) +and change the values of INST_DRV and INST_TOP. You can also enable +various build flags. These are explained in the makefiles. Note that it is generally not a good idea to try to build a perl with INST_DRV and INST_TOP set to a path that already exists from a previous @@ -363,7 +374,9 @@ may end up building against the installed perl's lib/CORE directory rather than the one being tested. You will have to make sure that CCTYPE is set correctly and that -CCHOME points to wherever you installed your compiler. +CCHOME points to wherever you installed your compiler. For GCC this +should be the directory that contains the F, F and +F directories. If building with the cross-compiler provided by mingw-w64.org you'll need to uncomment the line that sets @@ -376,24 +389,17 @@ The default value for CCHOME in the makefiles for Visual C++ may not be correct for some versions. Make sure the default exists and is valid. -You may also need to comment out the C line in the -Makefile if you're using VC++ 6.0 without the latest service pack and -the linker reports an internal error. - If you want build some core extensions statically into perl's dll, specify them in the STATIC_EXT macro. -NOTE: The USE_64_BIT_INT build option is not supported with the 32-bit -Visual C++ 6.0 compiler. - Be sure to read the instructions near the top of the makefiles carefully. =item * -Type "dmake" (or "nmake" if you are using that make). +Type "dmake" ("gmake" for GNU make, or "nmake" if you are using that make). This should build everything. Specifically, it will create perl.exe, -perl523.dll at the perl toplevel, and various other extension dll's +perl533.dll at the perl toplevel, and various other extension dll's under the lib\auto directory. If the build fails for any reason, make sure you have done the previous steps correctly. @@ -402,8 +408,11 @@ of parallel jobs you want to run. A number of things in the build process will run in parallel, but there are serialization points where you will see just 1 CPU maxed out. This is normal. +Similarly you can build in parallel with GNU make, type "gmake -j2" to +build with two parallel jobs, or higher for more. + If you are advanced enough with building C code, here is a suggestion to speed -up building perl, and the later C. Try to keep your PATH enviromental +up building perl, and the later C. Try to keep your PATH environmental variable with the least number of folders possible (remember to keep your C compiler's folders there). C or C depending on your OS version should be first folder in PATH, since "cmd.exe" @@ -413,23 +422,28 @@ is the most commonly launched program during the build and later testing. =head2 Testing Perl on Windows -Type "dmake test" (or "nmake test"). This will run most of the tests from -the testsuite (many tests will be skipped). +Type "dmake test" (or "gmake test", "nmake test"). This will run most +of the tests from the testsuite (many tests will be skipped). There should be no test failures. If you build with Visual C++ 2013 then three tests currently may fail with Daylight Saving Time related problems: F, -F and F. The failures are -caused by bugs in the CRT in VC++ 2013 which will be fixed in future releases -of VC++, as explained by Microsoft here: +F and F. The failures are +caused by bugs in the CRT in VC++ 2013 which are fixed in VC++2015 and +later, as explained by Microsoft here: L. In the meantime, if you need fixed C and C functions then have a look at the CPAN distribution Win32::UTCFileTime. +If you build with Visual C++ 2015 or later then F +may crash (after all its tests have passed). This is due to a regression in the +Universal CRT introduced in the Windows 10 April 2018 Update, and will be fixed +in the May 2019 Update, as explained here: L. + If you build with certain versions (e.g. 4.8.1) of gcc from www.mingw.org then F may fail test 17 due to a known bug in those gcc builds: -see L. +see L. Some test failures may occur if you use a command shell other than the native "cmd.exe", or if you are building from a path that contains @@ -444,15 +458,22 @@ include some tools (C for instance) which override the Windows ones and makes tests fail. Remove them from your path while testing to avoid these errors. -Please report any other failures as described under L. +To see the output of specific failing tests run the harness from the t +directory: + + # assuming you're starting from the win32 directory + cd ..\win32 + .\perl harness + +Please report any other failures as described under L. =head2 Installation of Perl on Windows -Type "dmake install" (or "nmake install"). This will put the newly -built perl and the libraries under whatever C points to in the -Makefile. It will also install the pod documentation under -C<$INST_TOP\$INST_VER\lib\pod> and HTML versions of the same under -C<$INST_TOP\$INST_VER\lib\pod\html>. +Type "dmake install" (or "gmake install", "nmake install"). This will +put the newly built perl and the libraries under whatever C +points to in the Makefile. It will also install the pod documentation +under C<$INST_TOP\$INST_VER\lib\pod> and HTML versions of the same +under C<$INST_TOP\$INST_VER\lib\pod\html>. To use the Perl you just installed you will need to add a new entry to your PATH environment variable: C<$INST_TOP\bin>, e.g. @@ -485,10 +506,14 @@ You can also control the shell that perl uses to run system() and backtick commands via PERL5SHELL. See L. Perl does not depend on the registry, but it can look up certain default -values if you choose to put them there. Perl attempts to read entries from -C and C. -Entries in the former override entries in the latter. One or more of the -following entries (of type REG_SZ or REG_EXPAND_SZ) may be set: +values if you choose to put them there unless disabled at build time with +USE_NO_REGISTRY. On Perl process start Perl checks if +C and C +exist. If the keys exists, they will be checked for remainder of the Perl +process's run life for certain entries. Entries in +C override entries in +C. One or more of the following entries +(of type REG_SZ or REG_EXPAND_SZ) may be set in the keys: lib-$] version-specific standard library path to add to @INC lib standard library path to add to @INC @@ -535,9 +560,9 @@ character is the double quote ("). It can be used to protect spaces and other special characters in arguments. The Windows documentation describes the shell parsing rules here: -L +L and the C runtime parsing rules here: -L. +L. Here are some further observations based on experiments: The C runtime breaks arguments at spaces and passes them to programs in argc/argv. @@ -606,11 +631,11 @@ quoted. The Comprehensive Perl Archive Network (CPAN) offers a wealth of extensions, some of which require a C compiler to build. -Look in L for more information on CPAN. +Look in L for more information on CPAN. Note that not all of the extensions available from CPAN may work in the Windows environment; you should check the information at -L before investing too much effort into +L before investing too much effort into porting modules that don't readily build. Most extensions (whether they require a C compiler or not) can @@ -636,9 +661,9 @@ L Another option is to use the make written in Perl, available from CPAN. -L +L -You may also use dmake. See L above on how to get it. +You may also use dmake or gmake. See L above on how to get it. Note that MakeMaker actually emits makefiles with different syntax depending on what 'make' it thinks you are using. Therefore, it is @@ -660,8 +685,8 @@ or any invocation of make. If a module does not build for some reason, look carefully for why it failed, and report problems to the module author. If it looks like the extension building support is at fault, report -that with full details of how the build failed using the perlbug -utility. +that with full details of how the build failed using the GitHub +issue tracker at L. =item Command-line Wildcard Expansion @@ -849,16 +874,15 @@ executable built during the installation process. Usage is exactly the same as normal C on Windows, except that options like C<-h> don't work (since they need a command-line window to print to). -If you find bugs in perl, you can run C to create a -bug report (you may have to send it manually if C cannot -find a mailer on your system). +If you find bugs in perl, you can report them to +L. =head1 BUGS AND CAVEATS Norton AntiVirus interferes with the build process, particularly if set to "AutoProtect, All Files, when Opened". Unlike large applications the perl build process opens and modifies a lot of files. Having the -the AntiVirus scan each and every one slows build the process significantly. +AntiVirus scan each and every one slows build the process significantly. Worse, with PERLIO=stdio the build process fails with peculiar messages as the virus checker interacts badly with miniperl.exe writing configure files (it seems to either catch file part written and treat it as suspicious, @@ -898,9 +922,9 @@ Thus, signals may work only for simple things like setting a flag variable in the handler. Using signals under this port should currently be considered unsupported. -Please send detailed descriptions of any problems and solutions that -you may find to EFE, along with the output -produced by C. +Please report detailed descriptions of any problems and solutions that +you may find at ELE, +along with the output produced by C. =head1 ACKNOWLEDGEMENTS @@ -946,6 +970,6 @@ Win9x support was added in 5.6 (Benjamin Stuhl). Support for 64-bit Windows added in 5.8 (ActiveState Corp). -Last updated: 07 October 2014 +Last updated: 30 April 2019 =cut