Skip to content

use Git/git instead of Mercurial/hg #67

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

Closed
wants to merge 6 commits into from
Closed
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 @@ -31,7 +31,7 @@ Python. If a new idea does not start here (or python-list_, discussed below),
it will get redirected here.

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
10 changes: 5 additions & 5 deletions devcycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ descendant of the ``3.5`` branch.

Therefore, each change should be made **first** in the oldest branch to which it
applies and forward-ported as appropriate: if a bug must be fixed in both Python
3.6 and 3.7, first fix it in ``3.6`` and then merge ``3.6`` into ``default``
3.6 and 3.7, first fix it in ``3.6`` and then merge ``3.6`` into ``master``
(which holds the future 3.7).


Expand All @@ -49,10 +49,10 @@ applies and forward-ported as appropriate: if a bug must be fixed in both Python
In-development (main) branch
----------------------------

The ``default`` branch is the branch for the next feature release; it is
The ``master`` branch is the branch for the next feature release; it is
under active development for all kinds of changes: new features, semantic
changes, performance improvements, bug fixes. As the name indicates, it
is the branch :ref:`checked out <checkout>` by default by Mercurial.
is the branch :ref:`checked out <checkout>` by default by Git.

At some point during the life-cycle of a release, a
new :ref:`maintenance branch <maintbranch>` is created to host all bug fixing
Expand Down Expand Up @@ -117,9 +117,9 @@ security patches have been applied to the branch.
Summary
-------

There are 7 open branches right now in the Mercurial repository:
There are 7 open branches right now in the Git repository:

- the ``default`` branch holds the future 3.7 version and descends from ``3.6``
- the ``master`` branch holds the future 3.7 version and descends from ``3.6``
(RM: Ned Deily)
- the ``3.6`` branch holds bug fixes for 3.6.0 and future 3.6.x maintenance releases
and descends from ``3.5`` (RM: Ned Deily)
Expand Down
3 changes: 3 additions & 0 deletions developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ transliteration too.
Permissions History
-------------------

- INADA Naoki was given push privileges on September 26, 2016 by Brett Cannon,
on the recommendation of Yury Selivanov.

- Xavier de Gaye was given push privileges on June 3, 2016 by Brett Cannon,
on the recommendation of Victor Stinner.

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.
20 changes: 7 additions & 13 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,25 @@ 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.

Detailed information can be found :ref:`here <compiling>`.
There are different instructions for :ref:`UNIX <unix-compiling>`,
:ref:`Mac OS <MacOS>`, and :ref:`Windows <windows-compiling>`.

The command to compile on UNIX is::
The command to compile on UNIX and Mac OS is::

./configure
make -j2

On some Mac OS::

CPPFLAGS="-I$(brew --prefix openssl)/include" \
LDFLAGS="-L$(brew --prefix openssl)/lib" \
./configure --with-pydebug
make -j

On Windows::

Expand Down Expand Up @@ -227,8 +221,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 @@ -297,7 +291,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
4 changes: 2 additions & 2 deletions runtests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Benchmarks
----------
Benchmarking is useful to test that a change does not degrade performance.

`The Grand Unified Python Benchmark Suite <https://hg.python.org/benchmarks/>`_
`The Python Benchmark Suite <https://github.com/python/performance>`_
has a collection of benchmarks for all Python implementations. Documentation
about running the benchmarks is in the `README.txt
<https://hg.python.org/benchmarks/file/tip/README.txt>`_ of the benchmarks repo.
<https://github.com/python/performance/blob/master/README.rst>`_ of the repo.
48 changes: 19 additions & 29 deletions setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ Getting Set Up
Version Control Setup
---------------------

CPython is developed using `Mercurial <http://hg-scm.org/>`_. The Mercurial
command line program is named ``hg``; this is also used to refer to Mercurial
itself. Mercurial is easily available for common Unix systems by way of the
standard package manager; under Windows, you might want to use the
`TortoiseHg <http://tortoisehg.org/>`_ graphical client, but the build system
still prefers :file:`hg.exe` to be on your PATH.
CPython is developed using `Git <https://git-scm.com/>`_. The Git command line
program is named ``git``; this is also used to refer to Git itself. Git is
easily available for common Unix systems by way of the standard package manager;
under Windows, you might want to use the `TortoiseGit <http://tortoisegit.org/>`_
Copy link
Member

Choose a reason for hiding this comment

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

It might be worth also linking to https://desktop.github.com/ as well at TortoiseGit.

Copy link
Member Author

Choose a reason for hiding this comment

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

sure, we have some possibilities for a desktop interface for Git.

graphical client, but the build system still prefers :file:`git.exe` to be on
your PATH.


.. _checkout:
Expand All @@ -49,13 +49,13 @@ To get a working copy of the :ref:`in-development <indevbranch>` branch of
CPython (core developers use a different URL as outlined in :ref:`coredev`),
run::

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

If you want a working copy of an already-released version of Python,
i.e., a version in :ref:`maintenance mode <maintbranch>`, you can update your
working copy. For instance, to update your working copy to Python 3.5, do::

hg update 3.5
git checkout 3.5

You will need to re-compile CPython when you do such an update.

Expand All @@ -75,17 +75,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 @@ -266,7 +264,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 @@ -346,16 +344,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
Mercurial repository. So if you don't touch the auto-generation scripts, there's
no real need to auto-generate anything. However, as Mercurial doesn't preserve
timestamps well, 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