diff --git a/Doc/README.txt b/Doc/README.rst similarity index 76% rename from Doc/README.txt rename to Doc/README.rst index 4f8e9f8f1417fb..39912c9f6fcdd1 100644 --- a/Doc/README.txt +++ b/Doc/README.rst @@ -43,14 +43,14 @@ the SPHINXBUILD variable. Available make targets are: -* "clean", which removes all build files. +* *clean*, which removes all build files. -* "html", which builds standalone HTML files for offline viewing. +* *html*, which builds standalone HTML files for offline viewing. -* "htmlview", which re-uses the "html" builder, but then opens the main page +* *htmlview*, which re-uses the "html" builder, but then opens the main page in your default web browser. -* "htmlhelp", which builds HTML files and a HTML Help project file usable to +* *htmlhelp*, which builds HTML files and a HTML Help project file usable to convert them into a single Compiled HTML (.chm) file -- these are popular under Microsoft Windows, but very handy on every platform. @@ -58,37 +58,37 @@ Available make targets are: over the generated project (.hhp) file. The make.bat script does this for you on Windows. -* "latex", which builds LaTeX source files as input to "pdflatex" to produce +* *latex*, which builds LaTeX source files as input to "pdflatex" to produce PDF documents. -* "text", which builds a plain text file for each source file. +* *text*, which builds a plain text file for each source file. -* "epub", which builds an EPUB document, suitable to be viewed on e-book +* *epub*, which builds an EPUB document, suitable to be viewed on e-book readers. -* "linkcheck", which checks all external references to see whether they are +* *linkcheck*, which checks all external references to see whether they are broken, redirected or malformed, and outputs this information to stdout as well as a plain-text (.txt) file. -* "changes", which builds an overview over all versionadded/versionchanged/ +* *changes*, which builds an overview over all versionadded/versionchanged/ deprecated items in the current version. This is meant as a help for the writer of the "What's New" document. -* "coverage", which builds a coverage overview for standard library modules and +* *coverage*, which builds a coverage overview for standard library modules and C API. -* "pydoc-topics", which builds a Python module containing a dictionary with +* *pydoc-topics*, which builds a Python module containing a dictionary with plain text documentation for the labels defined in `tools/pyspecific.py` -- pydoc needs these to show topic and keyword help. -* "suspicious", which checks the parsed markup for text that looks like +* *suspicious*, which checks the parsed markup for text that looks like malformed and thus unconverted reST. -* "check", which checks for frequent markup errors. +* *check*, which checks for frequent markup errors. -* "serve", which serves the build/html directory on port 8000. +* *serve*, which serves the build/html directory on port 8000. -* "dist", (Unix only) which creates distributable archives of HTML, text, +* *dist*, (Unix only) which creates distributable archives of HTML, text, PDF, and EPUB builds. diff --git a/PCbuild/README.rst b/PCbuild/README.rst new file mode 100644 index 00000000000000..cb2c47b81c84f8 --- /dev/null +++ b/PCbuild/README.rst @@ -0,0 +1,310 @@ +Quick Start Guide +----------------- + +1. Install Microsoft Visual Studio 2015, any edition. +2. Install Subversion, and make sure ``svn.exe`` is on your PATH. +3. Run ``build.bat -e`` to build Python in 32-bit Release configuration. +4. (Optional, but recommended) Run the test suite with ``rt.bat -q``. + + +Building Python using Microsoft Visual C++ +------------------------------------------ + +This directory is used to build CPython for Microsoft Windows NT version +6.0 or higher (Windows Vista, Windows Server 2008, or later) on 32 and 64 +bit platforms. Using this directory requires an installation of +Microsoft Visual C++ 2015 (MSVC 14.0) of any edition. The specific +requirements are as follows: + +- Visual Studio Express 2015 for Desktop +- Visual Studio Professional 2015 + + - Either edition is sufficient for building all configurations except + for Profile Guided Optimization. + - The Python build solution pcbuild.sln makes use of Solution Folders, + which this edition does not support. Any time pcbuild.sln is opened + or reloaded by Visual Studio, a warning about Solution Folders will + be displayed, which can be safely dismissed with no impact on your ability to build Python. + - Required for building 64-bit Debug and Release configuration builds + +- Visual Studio Premium 2015 + - Required for building Release configuration builds that make use of Profile Guided Optimization (PGO), on either platform. + +All you need to do to build is open the solution ``pcbuild.sln`` in Visual +Studio, select the desired combination of configuration and platform, +then build with *Build Solution*. You can also build from the command +line using the ``build.bat`` script in this directory; see below for +details. The solution is configured to build the projects in the correct +order. + +The solution currently supports two platforms. The Win32 platform is +used to build standard x86-compatible 32-bit binaries, output into the +win32 sub-directory. The x64 platform is used for building 64-bit AMD64 +(aka x86_64 or EM64T) binaries, output into the amd64 sub-directory. +The Itanium (IA-64) platform is no longer supported. + +Four configuration options are supported by the solution: + +- Debug: + Used to build Python with extra debugging capabilities, equivalent + to using ``./configure --with-pydebug`` on UNIX. All binaries built + using this configuration have ``_d`` added to their name: + ``python37_d.dll``, ``python_d.exe``, ``parser_d.pyd``, and so on. Both the + build and rt (run test) batch files in this directory accept a ``-d`` + option for debug builds. If you are building Python to help with + development of CPython, you will most likely use this configuration. + +- PGInstrument, PGUpdate: + Used to build Python in Release configuration using PGO, which + requires Premium Edition of Visual Studio. See the *Profile + Guided Optimization* section below for more information. Build + output from each of these configurations lands in its own + sub-directory of this directory. The official Python releases may + be built using these configurations. + +- Release: + Used to build Python as it is meant to be used in production + settings, though without PGO. + + +Building Python using the build.bat script +---------------------------------------------- + +In this directory you can find ``build.bat``, a script designed to make +building Python on Windows simpler. This script will use the ``env.bat`` +script to detect one of Visual Studio 2015, 2013, 2012, or 2010, any of +which may be used to build Python, though only Visual Studio 2015 is +officially supported. + +By default, ``build.bat`` will build Python in Release configuration for +the 32-bit Win32 platform. It accepts several arguments to change +this behavior, try ``build.bat -h`` to learn more. + + +C Runtime +--------- + +Visual Studio 2015 uses version 14 of the C runtime (*MSVCRT14*). The +executables no longer use the *Side by Side* assemblies used in previous +versions of the compiler. This simplifies distribution of applications. + +The run time libraries are available under the ``VC/Redist`` folder of your +Visual Studio distribution. For more info, see the Readme in the +``VC/Redist`` folder. + + +Sub-Projects +------------ + +The CPython project is split up into several smaller sub-projects which +are managed by the ``pcbuild.sln`` solution file. Each sub-project is +represented by a ``.vcxproj`` and a ``.vcxproj.filters`` file starting with the +name of the sub-project. These sub-projects fall into a few general +categories: + +The following sub-projects represent the bare minimum required to build +a functioning CPython interpreter. If nothing else builds but these, +you'll have a very limited but usable ``python.exe``: + +- pythoncore: ``.dll`` and ``.lib`` +- ``python.exe`` + +These sub-projects provide extra executables that are useful for running +CPython in different ways: + +- pythonw: + pythonw.exe, a variant of python.exe that doesn't open a Command + Prompt window + +- pylauncher + py.exe, the Python Launcher for Windows, see + http://docs.python.org/3/using/windows.html#launcher + +- pywlauncher: + pyw.exe, a variant of py.exe that doesn't open a Command Prompt + window + +- _testembed: + ``_testembed.exe``, a small program that embeds Python for testing + purposes, used by ``test_capi.py`` + +These are miscellaneous sub-projects that don't really fit the other +categories: + +- _freeze_importlib: + ``_freeze_importlib.exe``, used to regenerate ``Python\importlib.h`` after + changes have been made to ``Lib\importlib\_bootstrap.py`` + +- python3dll: + ``python3.dll``, the PEP 384 Stable ABI dll + +- xxlimited: + builds an example module that makes use of the PEP 384 Stable ABI, + see ``Modules\xxlimited.c`` + +The following sub-projects are for individual modules of the standard +library which are implemented in C; each one builds a DLL (renamed to +``.pyd``) of the same name as the project: + +- _ctypes +- _ctypes_test +- _decimal +- _elementtree +- _hashlib +- _msi +- _multiprocessing +- _overlapped +- _socket +- _testcapi +- _testbuffer +- _testimportmultiple +- pyexpat +- select +- unicodedata +- winsound + +The following Python-controlled sub-projects wrap external projects. +Note that these external libraries are not necessary for a working +interpreter, but they do implement several major features. See the +`Getting External Sources `_ +section below for additional information +about getting the source for building these libraries. The sub-projects +are: + +- _bz2 + Python wrapper for version 1.0.6 of the libbzip2 compression library. + Homepage: http://www.bzip.org/ + +- _lzma: + Python wrapper for the liblzma compression library, using pre-built + binaries of XZ Utils version 5.0.5. + Homepage: http://tukaani.org/xz/ + +- _ssl: + Python wrapper for version 1.0.2j of the OpenSSL secure sockets + library, which is built by ``ssl.vcxproj``. + Homepage: http://www.openssl.org/ + + Building OpenSSL requires nasm.exe (the Netwide Assembler), version + 2.10 or newer from `here `_ + to be somewhere on your PATH. More recent versions of OpenSSL may + need a later version of NASM. If OpenSSL's self tests don't pass, + you should first try to update NASM and do a full rebuild of + OpenSSL. If you use the ``PCbuild\get_externals.bat`` method + for getting sources, it also downloads a version of NASM which the + libeay/ssleay sub-projects use. + + The libeay/ssleay sub-projects expect your OpenSSL sources to have + already been configured and be ready to build. If you get your sources + from svn.python.org as suggested in the *Getting External Sources* + section below, the OpenSSL source will already be ready to go. If + you want to build a different version, you will need to run:: + + PCbuild\prepare_ssl.py path\to\openssl-source-dir + + That script will prepare your OpenSSL sources in the same way that + those available on svn.python.org have been prepared. Note that + Perl must be installed and available on your PATH to configure + OpenSSL. ActivePerl is recommended and is available from + `here `_. + + The libeay and ssleay sub-projects will build the modules of OpenSSL + required by _ssl and _hashlib and may need to be manually updated when + upgrading to a newer version of OpenSSL or when adding new + functionality to _ssl or _hashlib. They will not clean up their output + with the normal *Clean* target; *CleanAll* should be used instead. + +- _sqlite3: + Wraps SQLite 3.14.2.0, which is itself built by ``sqlite3.vcxproj``. + Homepage: http://www.sqlite.org/ + +- _tkinter: + Wraps version 8.6.6 of the Tk windowing system. + Homepage: http://www.tcl.tk/ + + Tkinter's dependencies are built by the ``tcl.vcxproj`` and ``tk.vcxproj`` + projects. The ``tix.vcxproj`` project also builds the Tix extended + widget set for use with Tkinter. + + Those three projects install their respective components in a + directory alongside the source directories called *tcltk* on + Win32 and *tcltk64* on x64. They also copy the Tcl and Tk DLLs + into the current output directory, which should ensure that Tkinter + is able to load Tcl/Tk without having to change your PATH. + + The tcl, tk, and tix sub-projects do not clean their builds with + the normal *Clean* target; if you need to rebuild, you should use the + *CleanAll* target or manually delete their builds. + + +Getting External Sources +------------------------ + +The last category of sub-projects listed above wrap external projects +Python doesn't control, and as such a little more work is required in +order to download the relevant source files for each project before they +can be built. However, a simple script is provided to make this as +painless as possible, called "get_externals.bat" and located in this +directory. This script extracts all the external sub-projects from +http://svn.python.org/projects/external +via Subversion (so you'll need ``svn.exe`` on your PATH) and places them +in ``..\externals`` (relative to this directory). + +It is also possible to download sources from each project's homepage, +though you may have to change folder names or pass the names to MSBuild +as the values of certain properties in order for the build solution to +find them. This is an advanced topic and not necessarily fully +supported. + +The ``get_externals.bat`` script is called automatically by ``build.bat`` when +you pass the ``-e`` option to it. + + +Profile Guided Optimization +--------------------------- + +The solution has two configurations for PGO. The *PGInstrument* +configuration must be built first. The *PGInstrument* binaries are linked +against a profiling library and contain extra debug information. The +*PGUpdate* configuration takes the profiling data and generates optimized +binaries. + +The ``build_pgo.bat`` script automates the creation of optimized binaries. +It creates the PGI files, runs the unit test suite or PyBench with the +PGI python, and finally creates the optimized files. + +See `MSDN `_ +for more on this topic. + + +Static library +-------------- + +The solution has no configuration for static libraries. However it is +easy to build a static library instead of a DLL. You simply have to set +the *Configuration Type* to *Static Library (.lib)* and alter the +preprocessor macro *Py_ENABLE_SHARED* to *Py_NO_ENABLE_SHARED*. You may +also have to change the *Runtime Library* from *Multi-threaded DLL +(/MD)* to *Multi-threaded (/MT)*. + + +Visual Studio properties +------------------------ + +The *PCbuild* solution makes use of Visual Studio property files (``*.props``) +to simplify each project. The properties can be viewed in the *Property +Manager* (*View -> Other Windows -> Property Manager*) but should be +carefully modified by hand. + +The property files used are: + +- python (versions, directories and build names) +- pyproject (base settings for all projects) +- openssl (used by libeay and ssleay projects) +- tcltk (used by _tkinter, tcl, tk and tix projects) + +The pyproject property file defines all of the build settings for each +project, with some projects overriding certain specific values. The GUI +doesn't always reflect the correct settings and may confuse the user +with false information, especially for settings that automatically adapt +for diffirent configurations. diff --git a/PCbuild/readme.txt b/PCbuild/readme.txt deleted file mode 100644 index 00b50be0175565..00000000000000 --- a/PCbuild/readme.txt +++ /dev/null @@ -1,300 +0,0 @@ -Quick Start Guide ------------------ - -1. Install Microsoft Visual Studio 2015, any edition. -2. Install Subversion, and make sure 'svn.exe' is on your PATH. -3. Run "build.bat -e" to build Python in 32-bit Release configuration. -4. (Optional, but recommended) Run the test suite with "rt.bat -q". - - -Building Python using Microsoft Visual C++ ------------------------------------------- - -This directory is used to build CPython for Microsoft Windows NT version -6.0 or higher (Windows Vista, Windows Server 2008, or later) on 32 and 64 -bit platforms. Using this directory requires an installation of -Microsoft Visual C++ 2015 (MSVC 14.0) of any edition. The specific -requirements are as follows: - -Visual Studio Express 2015 for Desktop -Visual Studio Professional 2015 - Either edition is sufficient for building all configurations except - for Profile Guided Optimization. - The Python build solution pcbuild.sln makes use of Solution Folders, - which this edition does not support. Any time pcbuild.sln is opened - or reloaded by Visual Studio, a warning about Solution Folders will - be displayed, which can be safely dismissed with no impact on your - ability to build Python. - Required for building 64-bit Debug and Release configuration builds -Visual Studio Premium 2015 - Required for building Release configuration builds that make use of - Profile Guided Optimization (PGO), on either platform. - -All you need to do to build is open the solution "pcbuild.sln" in Visual -Studio, select the desired combination of configuration and platform, -then build with "Build Solution". You can also build from the command -line using the "build.bat" script in this directory; see below for -details. The solution is configured to build the projects in the correct -order. - -The solution currently supports two platforms. The Win32 platform is -used to build standard x86-compatible 32-bit binaries, output into the -win32 sub-directory. The x64 platform is used for building 64-bit AMD64 -(aka x86_64 or EM64T) binaries, output into the amd64 sub-directory. -The Itanium (IA-64) platform is no longer supported. - -Four configuration options are supported by the solution: -Debug - Used to build Python with extra debugging capabilities, equivalent - to using ./configure --with-pydebug on UNIX. All binaries built - using this configuration have "_d" added to their name: - python37_d.dll, python_d.exe, parser_d.pyd, and so on. Both the - build and rt (run test) batch files in this directory accept a -d - option for debug builds. If you are building Python to help with - development of CPython, you will most likely use this configuration. -PGInstrument, PGUpdate - Used to build Python in Release configuration using PGO, which - requires Premium Edition of Visual Studio. See the "Profile - Guided Optimization" section below for more information. Build - output from each of these configurations lands in its own - sub-directory of this directory. The official Python releases may - be built using these configurations. -Release - Used to build Python as it is meant to be used in production - settings, though without PGO. - - -Building Python using the build.bat script ----------------------------------------------- - -In this directory you can find build.bat, a script designed to make -building Python on Windows simpler. This script will use the env.bat -script to detect one of Visual Studio 2015, 2013, 2012, or 2010, any of -which may be used to build Python, though only Visual Studio 2015 is -officially supported. - -By default, build.bat will build Python in Release configuration for -the 32-bit Win32 platform. It accepts several arguments to change -this behavior, try `build.bat -h` to learn more. - - -C Runtime ---------- - -Visual Studio 2015 uses version 14 of the C runtime (MSVCRT14). The -executables no longer use the "Side by Side" assemblies used in previous -versions of the compiler. This simplifies distribution of applications. - -The run time libraries are available under the VC/Redist folder of your -Visual Studio distribution. For more info, see the Readme in the -VC/Redist folder. - - -Sub-Projects ------------- - -The CPython project is split up into several smaller sub-projects which -are managed by the pcbuild.sln solution file. Each sub-project is -represented by a .vcxproj and a .vcxproj.filters file starting with the -name of the sub-project. These sub-projects fall into a few general -categories: - -The following sub-projects represent the bare minimum required to build -a functioning CPython interpreter. If nothing else builds but these, -you'll have a very limited but usable python.exe: -pythoncore - .dll and .lib -python - .exe - -These sub-projects provide extra executables that are useful for running -CPython in different ways: -pythonw - pythonw.exe, a variant of python.exe that doesn't open a Command - Prompt window -pylauncher - py.exe, the Python Launcher for Windows, see - http://docs.python.org/3/using/windows.html#launcher -pywlauncher - pyw.exe, a variant of py.exe that doesn't open a Command Prompt - window -_testembed - _testembed.exe, a small program that embeds Python for testing - purposes, used by test_capi.py - -These are miscellaneous sub-projects that don't really fit the other -categories: -_freeze_importlib - _freeze_importlib.exe, used to regenerate Python\importlib.h after - changes have been made to Lib\importlib\_bootstrap.py -python3dll - python3.dll, the PEP 384 Stable ABI dll -xxlimited - builds an example module that makes use of the PEP 384 Stable ABI, - see Modules\xxlimited.c - -The following sub-projects are for individual modules of the standard -library which are implemented in C; each one builds a DLL (renamed to -.pyd) of the same name as the project: -_ctypes -_ctypes_test -_decimal -_elementtree -_hashlib -_msi -_multiprocessing -_overlapped -_socket -_testcapi -_testbuffer -_testimportmultiple -pyexpat -select -unicodedata -winsound - -The following Python-controlled sub-projects wrap external projects. -Note that these external libraries are not necessary for a working -interpreter, but they do implement several major features. See the -"Getting External Sources" section below for additional information -about getting the source for building these libraries. The sub-projects -are: -_bz2 - Python wrapper for version 1.0.6 of the libbzip2 compression library - Homepage: - http://www.bzip.org/ -_lzma - Python wrapper for the liblzma compression library, using pre-built - binaries of XZ Utils version 5.0.5 - Homepage: - http://tukaani.org/xz/ -_ssl - Python wrapper for version 1.0.2j of the OpenSSL secure sockets - library, which is built by ssl.vcxproj - Homepage: - http://www.openssl.org/ - - Building OpenSSL requires nasm.exe (the Netwide Assembler), version - 2.10 or newer from - http://www.nasm.us/ - to be somewhere on your PATH. More recent versions of OpenSSL may - need a later version of NASM. If OpenSSL's self tests don't pass, - you should first try to update NASM and do a full rebuild of - OpenSSL. If you use the PCbuild\get_externals.bat method - for getting sources, it also downloads a version of NASM which the - libeay/ssleay sub-projects use. - - The libeay/ssleay sub-projects expect your OpenSSL sources to have - already been configured and be ready to build. If you get your sources - from svn.python.org as suggested in the "Getting External Sources" - section below, the OpenSSL source will already be ready to go. If - you want to build a different version, you will need to run - - PCbuild\prepare_ssl.py path\to\openssl-source-dir - - That script will prepare your OpenSSL sources in the same way that - those available on svn.python.org have been prepared. Note that - Perl must be installed and available on your PATH to configure - OpenSSL. ActivePerl is recommended and is available from - http://www.activestate.com/activeperl/ - - The libeay and ssleay sub-projects will build the modules of OpenSSL - required by _ssl and _hashlib and may need to be manually updated when - upgrading to a newer version of OpenSSL or when adding new - functionality to _ssl or _hashlib. They will not clean up their output - with the normal Clean target; CleanAll should be used instead. -_sqlite3 - Wraps SQLite 3.14.2.0, which is itself built by sqlite3.vcxproj - Homepage: - http://www.sqlite.org/ -_tkinter - Wraps version 8.6.6 of the Tk windowing system. - Homepage: - http://www.tcl.tk/ - - Tkinter's dependencies are built by the tcl.vcxproj and tk.vcxproj - projects. The tix.vcxproj project also builds the Tix extended - widget set for use with Tkinter. - - Those three projects install their respective components in a - directory alongside the source directories called "tcltk" on - Win32 and "tcltk64" on x64. They also copy the Tcl and Tk DLLs - into the current output directory, which should ensure that Tkinter - is able to load Tcl/Tk without having to change your PATH. - - The tcl, tk, and tix sub-projects do not clean their builds with - the normal Clean target; if you need to rebuild, you should use the - CleanAll target or manually delete their builds. - - -Getting External Sources ------------------------- - -The last category of sub-projects listed above wrap external projects -Python doesn't control, and as such a little more work is required in -order to download the relevant source files for each project before they -can be built. However, a simple script is provided to make this as -painless as possible, called "get_externals.bat" and located in this -directory. This script extracts all the external sub-projects from - http://svn.python.org/projects/external -via Subversion (so you'll need svn.exe on your PATH) and places them -in ..\externals (relative to this directory). - -It is also possible to download sources from each project's homepage, -though you may have to change folder names or pass the names to MSBuild -as the values of certain properties in order for the build solution to -find them. This is an advanced topic and not necessarily fully -supported. - -The get_externals.bat script is called automatically by build.bat when -you pass the '-e' option to it. - - -Profile Guided Optimization ---------------------------- - -The solution has two configurations for PGO. The PGInstrument -configuration must be built first. The PGInstrument binaries are linked -against a profiling library and contain extra debug information. The -PGUpdate configuration takes the profiling data and generates optimized -binaries. - -The build_pgo.bat script automates the creation of optimized binaries. -It creates the PGI files, runs the unit test suite or PyBench with the -PGI python, and finally creates the optimized files. - -See - http://msdn.microsoft.com/en-us/library/e7k32f4k(VS.140).aspx -for more on this topic. - - -Static library --------------- - -The solution has no configuration for static libraries. However it is -easy to build a static library instead of a DLL. You simply have to set -the "Configuration Type" to "Static Library (.lib)" and alter the -preprocessor macro "Py_ENABLE_SHARED" to "Py_NO_ENABLE_SHARED". You may -also have to change the "Runtime Library" from "Multi-threaded DLL -(/MD)" to "Multi-threaded (/MT)". - - -Visual Studio properties ------------------------- - -The PCbuild solution makes use of Visual Studio property files (*.props) -to simplify each project. The properties can be viewed in the Property -Manager (View -> Other Windows -> Property Manager) but should be -carefully modified by hand. - -The property files used are: - * python (versions, directories and build names) - * pyproject (base settings for all projects) - * openssl (used by libeay and ssleay projects) - * tcltk (used by _tkinter, tcl, tk and tix projects) - -The pyproject property file defines all of the build settings for each -project, with some projects overriding certain specific values. The GUI -doesn't always reflect the correct settings and may confuse the user -with false information, especially for settings that automatically adapt -for diffirent configurations. diff --git a/README b/README.rst similarity index 61% rename from README rename to README.rst index bd2735da87a520..1b0f6a713a473d 100644 --- a/README +++ b/README.rst @@ -1,9 +1,9 @@ This is Python version 3.7.0 alpha 1 ==================================== -Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, +*Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017 Python Software Foundation. All rights -reserved. +reserved.* Python 3.x is a new version of the language, which is incompatible with the 2.x line of releases. The language is mostly the same, but many details, @@ -15,28 +15,28 @@ been removed. Build Instructions ------------------ -On Unix, Linux, BSD, OSX, and Cygwin: +On Unix, Linux, BSD, OSX, and Cygwin:: ./configure make make test sudo make install -This will install Python as python3. +This will install Python as ``python3``. -You can pass many options to the configure script; run "./configure --help" to -find out more. On OSX and Cygwin, the executable is called python.exe; -elsewhere it's just python. +You can pass many options to the configure script; run ``./configure --help`` to +find out more. On OSX and Cygwin, the executable is called ``python.exe``; +elsewhere it's just ``python``. -On Mac OS X, if you have configured Python with --enable-framework, you should -use "make frameworkinstall" to do the installation. Note that this installs the -Python executable in a place that is not normally on your PATH, you may want to -set up a symlink in /usr/local/bin. +On Mac OS X, if you have configured Python with ``--enable-framework``, you should +use ``make frameworkinstall`` to do the installation. Note that this installs the +Python executable in a place that is not normally on your ``PATH``, you may want to +set up a symlink in ``/usr/local/bin``. -On Windows, see PCbuild/readme.txt. +On Windows, see `PCbuild/README.rst `_. -If you wish, you can create a subdirectory and invoke configure from there. -For example: +If you wish, you can create a subdirectory and invoke ``configure`` from there. +For example:: mkdir debug cd debug @@ -45,9 +45,9 @@ For example: make test (This will fail if you *also* built at the top-level directory. -You should do a "make clean" at the toplevel first.) +You should do a ``make clean`` at the toplevel first.) -To get an optimized build of Python, "configure --enable-optimizations" before +To get an optimized build of Python, ``./configure --enable-optimizations`` before you run make. This sets the default make targets up to enable Profile Guided Optimization (PGO) and may be used to auto-enable Link Time Optimization (LTO) on some platforms. For more details, see the sections bellow. @@ -57,7 +57,7 @@ Profile Guided Optimization --------------------------- PGO takes advantage of recent versions of the GCC or Clang compilers. -If ran, "make profile-opt" will do several steps. +If ran, ``make profile-opt`` will do several steps. First, the entire Python directory is cleaned of temporary files that may have resulted in a previous compilation. @@ -80,8 +80,8 @@ that is optimized and suitable for distribution or production installation. Link Time Optimization ---------------------- -Enabled via configure's --with-lto flag. LTO takes advantages of recent -compiler toolchains ability to optimize across the otherwise arbitrary .o file +Enabled via configure's ``--with-lto`` flag. LTO takes advantages of recent +compiler toolchains ability to optimize across the otherwise arbitrary *.o* file boundary when building final executables or shared libraries for additional performance gains. @@ -89,25 +89,24 @@ performance gains. What's New ---------- -We have a comprehensive overview of the changes in the "What's New in -Python 3.7" document, found at - - https://docs.python.org/3.7/whatsnew/3.7.html +We have a comprehensive overview of the changes in the `What's New in +Python 3.7 document `_. -For a more detailed change log, read Misc/NEWS (though this file, too, +For a more detailed change log, read +`Misc/NEWS `_ +(though this file, too, is incomplete, and also doesn't list anything merged in from the 2.7 release under development). If you want to install multiple versions of Python see the section below -entitled "Installing multiple versions". +entitled +`Installing multiple versions `_. Documentation ------------- -Documentation for Python 3.7 is online, updated daily: - - https://docs.python.org/3.7/ +Documentation for Python 3.7 is `online `_, updated daily. It can also be downloaded in many formats for faster access. The documentation is downloadable in HTML, PDF, and reStructuredText formats; the latter version @@ -115,11 +114,10 @@ is primarily for documentation authors, translators, and people with special formatting requirements. If you would like to contribute to the development of Python, relevant -documentation is available at: +documentation is available at the `devguide `_. - https://docs.python.org/devguide/ - -For information about building Python's documentation, refer to Doc/README.txt. +For information about building Python's documentation, refer to +`Doc/README.rst `_. Converting From Python 2.x to 3.x @@ -129,16 +127,16 @@ Python starting with 2.6 contains features to help locating code that needs to be changed, such as optional warnings when deprecated features are used, and backported versions of certain key Python 3.x features. -A source-to-source translation tool, "2to3", can take care of the mundane task +A source-to-source translation tool, *2to3*, can take care of the mundane task of converting large amounts of source code. It is not a complete solution but is complemented by the deprecation warnings in 2.6. See -https://docs.python.org/3.7/library/2to3.html for more information. +`the documentation `_ for more information. Testing ------- -To test the interpreter, type "make test" in the top-level directory. +To test the interpreter, type ``make test`` in the top-level directory. The test set produces some output. You can generally ignore the messages about skipped tests due to optional features which can't be imported. If a message is printed about a failed test or a traceback or core dump @@ -147,13 +145,13 @@ is produced, something is wrong. By default, tests are prevented from overusing resources like disk space and memory. To enable these tests, run "make testall". -IMPORTANT: If the tests fail and you decide to mail a bug report, *don't* -include the output of "make test". It is useless. Run the failing test -manually, as follows: +**IMPORTANT:** If the tests fail and you decide to mail a bug report, *don't* +include the output of ``make test``. It is useless. Run the failing test +manually, as follows:: ./python -m test -v test_whatever -(substituting the top of the source tree for '.' if you built in a different +(substituting the top of the source tree for ``.`` if you built in a different directory). This runs the test in verbose mode. @@ -161,37 +159,30 @@ Installing multiple versions ---------------------------- On Unix and Mac systems if you intend to install multiple versions of Python -using the same installation prefix (--prefix argument to the configure script) +using the same installation prefix (``--prefix`` argument to the configure script) you must take care that your primary python executable is not overwritten by the installation of a different version. All files and directories installed using -"make altinstall" contain the major and minor version and can thus live -side-by-side. "make install" also creates ${prefix}/bin/python3 which refers to -${prefix}/bin/pythonX.Y. If you intend to install multiple versions using the +``make altinstall`` contain the major and minor version and can thus live +side-by-side. ``make install`` also creates ``${prefix}/bin/python3`` which refers to +``${prefix}/bin/pythonX.Y``. If you intend to install multiple versions using the same prefix you must decide which version (if any) is your "primary" version. -Install that version using "make install". Install all other versions using -"make altinstall". +Install that version using ``make install``. Install all other versions using +``make altinstall``. For example, if you want to install Python 2.7, 3.6, and 3.7 with 3.7 being the -primary version, you would execute "make install" in your 3.7 build directory -and "make altinstall" in the others. +primary version, you would execute ``make install`` in your 3.7 build directory +and ``make altinstall`` in the others. Issue Tracker and Mailing List ------------------------------ We're soliciting bug reports about all aspects of the language. Fixes are also -welcome, preferably in unified diff format. Please use the issue tracker: - - https://bugs.python.org/ +welcome, preferably in unified diff format. +Please use the `issue tracker `_ If you're not sure whether +you're dealing with a bug or a feature, use the `mailing list `_: -If you're not sure whether you're dealing with a bug or a feature, use the -mailing list: - - python-dev@python.org - -To subscribe to the list, use the mailman form: - - https://mail.python.org/mailman/listinfo/python-dev/ +To subscribe to the list, use the `mailman form `_. Proposals for enhancement @@ -201,13 +192,13 @@ If you have a proposal to change Python, you may want to send an email to the comp.lang.python or python-ideas mailing lists for initial feedback. A Python Enhancement Proposal (PEP) may be submitted if your idea gains ground. All current PEPs, as well as guidelines for submitting a new PEP, are listed at -https://www.python.org/dev/peps/. +`https://www.python.org/dev/peps/ `_. Release Schedule ---------------- -See PEP 494 for release details: https://www.python.org/dev/peps/pep-0494/ +See `PEP 494 `_ for release details. Copyright and License Information @@ -223,7 +214,8 @@ rights reserved. Copyright (c) 1991-1995 Stichting Mathematisch Centrum. All rights reserved. -See the file "LICENSE" for information on the history of this software, +See the file `LICENSE `_ for +information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES. This Python distribution contains *no* GNU General Public License (GPL) code, @@ -231,4 +223,3 @@ so it may be used in proprietary projects. There are interfaces to some GNU code but these are entirely optional. All trademarks referenced herein are property of their respective holders. -