Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename README to README.rst and enhance formatting #2

Merged
merged 1 commit into from
Feb 11, 2017
Merged

Rename README to README.rst and enhance formatting #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile.pre.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ SUBDIRSTOO= Include Lib Misc

# Files and directories to be distributed
CONFIGFILES= configure configure.ac acconfig.h pyconfig.h.in Makefile.pre.in
DISTFILES= README ChangeLog $(CONFIGFILES)
DISTFILES= README.rst ChangeLog $(CONFIGFILES)
DISTDIRS= $(SUBDIRS) $(SUBDIRSTOO) Ext-dummy
DIST= $(DISTFILES) $(DISTDIRS)

Expand Down
93 changes: 43 additions & 50 deletions README → README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ been removed.
Build Instructions
------------------

On Unix, Linux, BSD, OSX, and Cygwin:
On Unix, Linux, BSD, OSX, and Cygwin::

./configure
make
Expand All @@ -24,19 +24,19 @@ On Unix, Linux, BSD, OSX, and Cygwin:

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
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.
set up a symlink in ``/usr/local/bin``.

On Windows, see PCbuild/readme.txt.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could link to the actual file (https://github.com/python/cpython/blob/master/PCbuild/readme.txt).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Such change are out of the scope of my initial change. I suggest to make more enhancements in a second change.


If you wish, you can create a subdirectory and invoke configure from there.
For example:
For example::

mkdir debug
cd debug
Expand All @@ -45,10 +45,10 @@ 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
you run make. This sets the default make targets up to enable Profile Guided
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.

Expand All @@ -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.
Expand All @@ -80,19 +80,17 @@ 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.


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 <https://docs.python.org/3.7/whatsnew/3.7.html>`_ document.

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
Expand All @@ -105,19 +103,17 @@ 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 <https://docs.python.org/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
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:

https://docs.python.org/devguide/
documentation is available at: `Python Developer's Guide
<https://docs.python.org/devguide/>`_.

For information about building Python's documentation, refer to Doc/README.txt.

Expand All @@ -129,27 +125,28 @@ 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.
`2to3 documentation <https://docs.python.org/3.7/library/2to3.html>`_ 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
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".
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:
include the output of ``make test``. It is useless. Run the failing test
manually, as follows::

./python -m test -v test_whatever

Expand All @@ -161,53 +158,49 @@ 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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole section can use updating:

Bug reports are welcome!  You can use the `issue tracker
<https://bugs.python.org>`_ to report bugs, and/or submit pull requests `on
Github <https://github.com/python/cpython>`_.

You can also follow development discussion on the `python-dev mailing list
<https://mail.python.org/mailman/listinfo/python-dev/>`_.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto.


https://bugs.python.org/
`bugs.python.org <https://bugs.python.org/>`_.

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/
mailing list: python-dev@python.org. To subscribe to the list, use the mailman
form: `python-dev <https://mail.python.org/mailman/listinfo/python-dev/>`_


Proposals for enhancement
-------------------------

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
comp.lang.python or
`python-ideas <https://mail.python.org/mailman/listinfo/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/.
`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:`537` for Python 3.7 release details.


Copyright and License Information
Expand Down