Skip to content

Clean mentions of Mercurial #77

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.

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 7 commits into from
Oct 28, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 communication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ tree is frozen for commits, etc.), it is discussed here instead of python-dev
to keep traffic down on the latter.

Python-checkins_ sends out an email for every commit to Python's various
repositories from https://hg.python.org. All core developers
repositories from https://github.com/python/cpython. All core developers
subscribe to this list and are known to reply to these emails to make comments
about various issues they catch in the commit. Replies get redirected to
python-dev.
Expand Down
2 changes: 1 addition & 1 deletion documenting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ documentation and how it should be used.

The documentation in HTML, PDF or EPUB format is generated from text files
written using the :ref:`reStructuredText format <markup>` and contained in the
:ref:`CPython Mercurial repository <setup>`.
:ref:`CPython Git repository <setup>`.

.. _reStructuredText: http://docutils.sf.net/rst.html

Expand Down
2 changes: 1 addition & 1 deletion grammar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@ Checklist

* After everything has been checked in, you're likely to see a new
change to Python/Python-ast.c. This is because this
(generated) file contains the hg version of the source from
(generated) file contains the git version of the source from
which it was generated. There's no way to avoid this; you just
have to submit this file separately.
10 changes: 5 additions & 5 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ patch:

1. Set up and install dependencies.

Install :ref:`Mercurial <vcsetup>` and other dependencies.
Install :ref:`Git <vcsetup>` and other dependencies.

The dependencies needed will depend on the platform you're on.
Go to :ref:`Get Setup <setup>` page for detailed information.

2. :ref:`Get the source code <checkout>`::

hg clone https://hg.python.org/cpython
git clone https://github.com/python/cpython

3. Build Python.

Expand Down Expand Up @@ -218,8 +218,8 @@ Key Resources
* `Firefox search engine plug-in`_
* `Buildbot status`_
* Source code
* `Browse online <https://hg.python.org/cpython/file/default/>`_
* `Snapshot of py3k <https://hg.python.org/cpython/archive/default.tar.bz2>`_
* `Browse online <https://github.com/python/cpython/>`_
* `Snapshot of the *master* branch <https://github.com/python/cpython/archive/master.zip>`_
* `Daily OS X installer <http://buildbot.python.org/daily-dmg/>`_
* PEPs_ (Python Enhancement Proposals)
* :doc:`faq`
Expand Down Expand Up @@ -288,7 +288,7 @@ Full Table of Contents

.. _Buildbot status: https://www.python.org/dev/buildbot/
.. _Firefox search engine plug-in: https://www.python.org/dev/searchplugin/
.. _Misc directory: https://hg.python.org/cpython/file/default/Misc
.. _Misc directory: https://github.com/python/cpython/tree/master/Misc
.. _PEPs: https://www.python.org/dev/peps/
.. _python.org maintenance: https://pythondotorg.readthedocs.io/
.. _Python: https://www.python.org/
Expand Down
45 changes: 20 additions & 25 deletions setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,16 @@ itself. git is easily available for all common operating systems. As the
CPython repo is hosted on GitHub, please refer to either the
`GitHub setup instructions <https://help.github.com/articles/set-up-git/>`_
or the `git project instructions <https://git-scm.com>`_ for step-by-step
installation directions.
installation directions. You may also want to consider a graphical client
such as `TortoiseGit <http://tortoisegit.org/>`_ or
`GitHub Desktop <https://desktop.github.com/>`_.

You may also wish to
`set up an SSH key <https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/>`_
as this will allow you to interact with GitHub without typing a username
and password each time you execute a command, such as ``git pull``,
``git push``, or ``git fetch``.

You may also wish to set up an SSH key as
described in the GitHub instructions as this will allow you to interact with
GitHub without typing a username and password each time you execute a
command, such as `git pull`, `git push`, or `git fetch`.

.. _checkout:

Expand Down Expand Up @@ -80,17 +84,15 @@ Compiling (for debugging)

CPython provides several compilation flags which help with debugging various
things. While all of the known flags can be found in the
``Misc/SpecialBuilds.txt``
file, the most critical one is the ``Py_DEBUG`` flag which creates what is
known as a "pydebug" build. This flag turns on
various extra sanity checks which help catch common issues. The use of the flag
is so common that turning on the flag is a basic compile option.
``Misc/SpecialBuilds.txt`` file, the most critical one is the ``Py_DEBUG`` flag
which creates what is known as a "pydebug" build. This flag turns on various
extra sanity checks which help catch common issues. The use of the flag is so
common that turning on the flag is a basic compile option.

You should always
develop under a pydebug build of CPython (the only instance of when you
shouldn't is if you are taking performance measurements). Even when working
only on pure Python code the pydebug build provides several useful checks that
one should not skip.
You should always develop under a pydebug build of CPython (the only instance of
when you shouldn't is if you are taking performance measurements). Even when
working only on pure Python code the pydebug build provides several useful
checks that one should not skip.


.. _build-dependencies:
Expand Down Expand Up @@ -271,7 +273,7 @@ still build properly).
Windows
'''''''

The `readme <https://hg.python.org/cpython/file/default/PCbuild/readme.txt>`_
The `readme <https://github.com/python/cpython/blob/master/PCbuild/readme.txt>`_
included in the solution has more details, especially on what additional
software is required to build which parts of Python.

Expand Down Expand Up @@ -351,15 +353,8 @@ when trying to build an old (2.x) Python with a new (3.x) Python installed, or
vice versa.

To overcome this problem, auto-generated files are also checked into the
git repository. So if you don't touch the auto-generation scripts, there's
no real need to auto-generate anything. A special build target ``touch`` was added (the ``touch``
build target is not designed for git clones and does not support them). Run::

make touch

Before running the compilation ``make``. This will tweak the timestamps of the
auto-generated files in a way that makes it unnecessary to create them anew and
henceforth the compilation should not require an installed Python interpreter.
Git repository. So if you don't touch the auto-generation scripts, there's
no real need to auto-generate anything.

Editors and Tools
=================
Expand Down