8000 Update readme by zware · Pull Request #21 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Update readme #21

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

Merged
merged 5 commits into from
Feb 14, 2017
Merged

Update readme #21

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4fffc3f
Various updates to README.rst
zware Feb 11, 2017
ca7c4f6
Rewrap at 80 columns
zware Feb 11, 2017
a5ebe4b
Capitalize the 'H' in GitHub
zware Feb 11, 2017
5bbcd3a
Soften verbose testing section
zware Feb 11, 2017
5a20814
Fix awkward construction in LTO section
zware Feb 12, 2017
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
Next Next commit
Various updates to README.rst 
These include spelling/grammar fixes, removing some outdated prose,
updating some superceded prose, and adding/cleaning up some links.
  • Loading branch information
@zware
zware committed Feb 14, 2017
commit 4fffc3fd7f69c02826ac73baa48c452f33808661
56 changes: 24 additions & 32 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,7 @@ 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.

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.
See the end of this file for further copyright and license information.

Using Python
------------
Expand Down Expand Up @@ -49,7 +45,8 @@ use ``make frameworkinstall`` to do the installation. Note that this installs t
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.txt
<https://github.com/python/cpython/blob/master/PCbuild/readme.txt>`_.

If you wish, you can create a subdirectory and invoke configure from there.
For example::
Expand All @@ -66,7 +63,7 @@ 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
Optimization (PGO) and may be used to auto-enable Link Time Optimization (LTO)
on some platforms. For more details, see the sections bellow.
on some platforms. For more details, see the sections below.


Profile Guided Optimization
Expand Down Expand Up @@ -97,7 +94,7 @@ 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
compiler toolchains' ability to optimize across the otherwise arbitrary ``.o`` file
boundary when building final executables or shared libraries for additional
performance gains.

Expand All @@ -106,11 +103,11 @@ What's New
----------

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
release under development).
Python 3.7 <https://docs.python.org/3.7/whatsnew/3.7.html>`_ document. For a
more detailed change log, read `Misc/NEWS
<https://github.com/python/cpython/blob/master/Misc/NEWS>`_, but a full
accounting of changes can only be gleaned from the `commit history
<https://github.com/python/cpython/commits/master>`_.

If you want to install multiple versions of Python see the section below
entitled "Installing multiple versions".
Expand All @@ -128,24 +125,20 @@ 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: `Python Developer's Guide
documentation is available in the `Python Developer's Guide
<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.txt
<https://github.com/python/cpython/blob/master/Doc/README.txt>`_.


Converting From Python 2.x to 3.x
---------------------------------

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
of converting large amounts of source code. It is not a complete solution but
is complemented by the deprecation warnings in 2.6. See
`2to3 documentation <https://docs.python.org/3.7/library/2to3.html>`_ for more
information.
Significant backward incompatible changes were made for the release of Python
3.0, which may cause programs written for Python 2 to fail when run with Python
3. For more information about porting your code from Python 2 to Python 3, see
the `Porting HOWTO <https://docs.python.org/3/howto/pyporting.html>`_.


Testing
Expand All @@ -160,14 +153,14 @@ 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*
IMPORTANT: If the tests fail and you decide to file a bug report, *don't*
include the output of ``make test``. It is useless. Run the failing test
manually, as follows::
Copy link
Member
@ezio-melotti ezio-melotti Feb 11, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

This paragraph is a bit harsh, from the uppercase "IMPORTANT" to calling the output of "make test" "useless".

I would rewrite it as:

If the tests fail, you can run the failing test(s) in verbose mode using:
./python -m test -v test_that_failed
You should then file a bug report and include the output of this command.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, will amend.

Copy link
Member

Choose a reason for hiding this comment

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

Maybe we could keep a consistence, ./python -m test -v test_that_failed or make test TESTOPTS="-v" test_that_failed

Copy link
Member Author

Choose a reason for hiding this comment

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

@matrixise I'm not sure I understand your point. I switched to make test TESTOPTS="-v test_that_failed" because running the tests is suggested with make test, and there was previously a note about what to do if you built python in a different directory. Reusing make test with TESTOPTS means the different directory question just goes away, but we get exactly the same result.


./python -m test -v test_whatever

(substituting the top of the source tree for '.' if you built in a different
directory). This runs the test in verbose mode.
directory). This runs only the failing test in verbose mode.


Installing multiple versions
Expand All @@ -192,13 +185,12 @@ 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:
`bugs.python.org <https://bugs.python.org/>`_.
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>`_.
Copy link
Member

Choose a reason for hiding this comment

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

GitHub with capital H :)

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks!


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


Proposals for enhancement
Expand Down
0