diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 128 |
1 files changed, 83 insertions, 45 deletions
@@ -1,13 +1,14 @@ -This is Python version 3.4.5 -============================ +This is Python version 3.5.3 release candidate 1 +================================================ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Python Software Foundation. All rights 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, especially -how built-in objects like dictionaries and strings work, have changed -considerably, and a lot of deprecated features have finally been removed. +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, +especially how built-in objects like dictionaries and strings work, +have changed considerably, and a lot of deprecated features have finally +been removed. Build Instructions @@ -15,8 +16,6 @@ Build Instructions On Unix, Linux, BSD, OSX, and Cygwin: -New text - ./configure make make test @@ -29,14 +28,14 @@ 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. +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. -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 @@ -44,21 +43,59 @@ example: make make test -(This will fail if you *also* built at the top-level directory. You should do a -"make clean" at the toplevel first.) +(This will fail if you *also* built at the top-level directory. +You should do a "make clean" at the toplevel first.) + +To get an optimized build of Python, "configure --with-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. + + +Profile Guided Optimization +--------------------------- + +PGO takes advantage of recent versions of the GCC or Clang compilers. +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. + +Then, an instrumented version of the interpreter is built, using suitable +compiler flags for each flavour. Note that this is just an intermediary +step and the binary resulted after this step is not good for real life +workloads, as it has profiling instructions embedded inside. + +After this instrumented version of the interpreter is built, the Makefile +will automatically run a training workload. This is necessary in order to +profile the interpreter execution. Note also that any output, both stdout +and stderr, that may appear at this step is suppressed. + +Finally, the last step is to rebuild the interpreter, using the information +collected in the previous one. The end result will be a Python binary +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 +boundary when building final executables or shared libraries for additional +performance gains. What's New ---------- -We try to have a comprehensive overview of the changes in the "What's New in -Python 3.4" document, found at +We have a comprehensive overview of the changes in the "What's New in +Python 3.5" document, found at - http://docs.python.org/3.4/whatsnew/3.4.html + http://docs.python.org/3.5/whatsnew/3.5.html -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). +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". @@ -67,9 +104,9 @@ entitled "Installing multiple versions". Documentation ------------- -Documentation for Python 3.4 is online, updated daily: +Documentation for Python 3.5 is online, updated daily: - http://docs.python.org/3.4/ + http://docs.python.org/3.5/ It can also be downloaded in many formats for faster access. The documentation is downloadable in HTML, PDF, and reStructuredText formats; the latter version @@ -94,16 +131,17 @@ backported versions of certain key Python 3.x features. 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 -http://docs.python.org/3.4/library/2to3.html for more information. +http://docs.python.org/3.5/library/2to3.html for more information. Testing ------- -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 is produced, something is wrong. +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 +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". @@ -123,16 +161,16 @@ 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) -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 -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". - -For example, if you want to install Python 2.6, 2.7 and 3.4 with 2.7 being the +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 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". + +For example, if you want to install Python 2.6, 2.7 and 3.5 with 2.7 being the primary version, you would execute "make install" in your 2.7 build directory and "make altinstall" in the others. @@ -141,7 +179,7 @@ Issue Tracker and Mailing List ------------------------------ We're soliciting bug reports about all aspects of the language. Fixes are also -welcome, preferable in unified diff format. Please use the issue tracker: +welcome, preferably in unified diff format. Please use the issue tracker: http://bugs.python.org/ @@ -168,7 +206,7 @@ http://www.python.org/dev/peps/. Release Schedule ---------------- -See PEP 429 for release details: http://www.python.org/dev/peps/pep-0429/ +See PEP 478 for release details: http://www.python.org/dev/peps/pep-0478/ Copyright and License Information @@ -184,11 +222,11 @@ rights reserved. Copyright (c) 1991-1995 Stichting Mathematisch Centrum. All rights reserved. -See the file "LICENSE" for information on the history of this software, terms & -conditions for usage, and a DISCLAIMER OF ALL WARRANTIES. +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, so -it may be used in proprietary projects. There are interfaces to some GNU code -but these are entirely optional. +This Python distribution contains *no* GNU General Public License (GPL) code, +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. |