diff --git a/communication.rst b/communication.rst index abda06e69e..7258d70683 100644 --- a/communication.rst +++ b/communication.rst @@ -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. diff --git a/documenting.rst b/documenting.rst index 15c1ac15b1..0d193438e1 100644 --- a/documenting.rst +++ b/documenting.rst @@ -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 ` and contained in the -:ref:`CPython Mercurial repository `. +:ref:`CPython Git repository `. .. _reStructuredText: http://docutils.sf.net/rst.html diff --git a/grammar.rst b/grammar.rst index 0dec6302df..328bda665e 100644 --- a/grammar.rst +++ b/grammar.rst @@ -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. diff --git a/index.rst b/index.rst index f971c6a750..cafae0948f 100644 --- a/index.rst +++ b/index.rst @@ -16,14 +16,14 @@ patch: 1. Set up and install dependencies. - Install :ref:`Mercurial ` and other dependencies. + Install :ref:`Git ` and other dependencies. The dependencies needed will depend on the platform you're on. Go to :ref:`Get Setup ` page for detailed information. 2. :ref:`Get the source code `:: - hg clone https://hg.python.org/cpython + git clone https://github.com/python/cpython 3. Build Python. @@ -218,8 +218,8 @@ Key Resources * `Firefox search engine plug-in`_ * `Buildbot status`_ * Source code - * `Browse online `_ - * `Snapshot of py3k `_ + * `Browse online `_ + * `Snapshot of the *master* branch `_ * `Daily OS X installer `_ * PEPs_ (Python Enhancement Proposals) * :doc:`faq` @@ -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/ diff --git a/setup.rst b/setup.rst index 8ad6cc9868..0f0807cda9 100644 --- a/setup.rst +++ b/setup.rst @@ -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 `_ or the `git project instructions `_ for step-by-step -installation directions. +installation directions. You may also want to consider a graphical client +such as `TortoiseGit `_ or +`GitHub Desktop `_. + +You may also wish to +`set up an SSH key `_ +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: @@ -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: @@ -271,7 +273,7 @@ still build properly). Windows ''''''' -The `readme `_ +The `readme `_ included in the solution has more details, especially on what additional software is required to build which parts of Python. @@ -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 =================