Skip to content

Commit

Permalink
Merge pull request #9743 from pradyunsg/docs/rename-branch
Browse files Browse the repository at this point in the history
  • Loading branch information
pradyunsg authored Mar 28, 2021
2 parents bcbfbaa + 1db5ce0 commit 7ec0fa5
Show file tree
Hide file tree
Showing 8 changed files with 38 additions and 38 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/resolver-failure.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ labels: ["K: UX", "K: crash", "C: new resolver", "C: dependency resolution"]
<!--
Please provide as much information as you can about your failure, so that we can understand the root cause.
Try if your issue has been fixed in the in-development version of pip. Use the following command to install pip from master:
Try if your issue has been fixed in the in-development version of pip. Use the following command to install pip from the current development branch:
python -m pip install -U "pip @ https://github.com/pypa/pip/archive/master.zip"
python -m pip install -U "pip @ https://github.com/pypa/pip/archive/main.zip"
-->

**What did you want to do?**
Expand Down
2 changes: 1 addition & 1 deletion docs/html/copyright.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Copyright

pip and this documentation is:

Copyright © 2008-2020 The pip developers (see `AUTHORS.txt <https://github.com/pypa/pip/blob/master/AUTHORS.txt>`_ file). All rights reserved.
Copyright © 2008-2020 The pip developers (see `AUTHORS.txt <https://github.com/pypa/pip/blob/main/AUTHORS.txt>`_ file). All rights reserved.
2 changes: 1 addition & 1 deletion docs/html/development/architecture/anatomy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,5 @@ Within ``src/``:

.. _`tracking issue`: https://github.com/pypa/pip/issues/6831
.. _GitHub repository: https://github.com/pypa/pip/
.. _tox.ini: https://github.com/pypa/pip/blob/master/tox.ini
.. _tox.ini: https://github.com/pypa/pip/blob/main/tox.ini
.. _improving the pip dependency resolver: https://github.com/pypa/pip/issues/988
34 changes: 17 additions & 17 deletions docs/html/development/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ We have an in-progress guide to the
Submitting Pull Requests
========================

Submit pull requests against the ``master`` branch, providing a good
Submit pull requests against the ``main`` branch, providing a good
description of what you're doing and why. You must have legal permission to
distribute any code you contribute to pip and it must be available under the
MIT License.
Expand Down Expand Up @@ -39,7 +39,7 @@ separately, as a "formatting cleanup" PR, if needed.
Automated Testing
=================

All pull requests and merges to 'master' branch are tested using `Travis CI`_,
All pull requests and merges to 'main' branch are tested using `Travis CI`_,
`Azure Pipelines`_ and `GitHub Actions`_ based on our `.travis.yml`_,
`.azure-pipelines`_ and `.github/workflows`_ files. More details about pip's
Continuous Integration can be found in the `CI Documentation`_
Expand Down Expand Up @@ -131,8 +131,8 @@ updating deprecation policy, etc.
Updating your branch
====================

As you work, you might need to update your local master branch up-to-date with
the ``master`` branch in the main pip repository, which moves forward as the
As you work, you might need to update your local main branch up-to-date with
the ``main`` branch in the main pip repository, which moves forward as the
maintainers merge pull requests. Most people working on the project use the
following workflow.

Expand Down Expand Up @@ -160,24 +160,24 @@ First, fetch the latest changes from the main pip repository, ``upstream``:
git fetch upstream
Then, check out your local ``master`` branch, and rebase the changes on top of
Then, check out your local ``main`` branch, and rebase the changes on top of
it:

.. code-block:: console
git checkout master
git rebase upstream/master
git checkout main
git rebase upstream/main
At this point, you might have to `resolve merge conflicts`_. Once this is done,
push the updates you have just made to your local ``master`` branch to your
push the updates you have just made to your local ``main`` branch to your
``origin`` repository on GitHub:

.. code-block:: console
git checkout master
git push origin master
git checkout main
git push origin main
Now your local ``master`` branch and the ``master`` branch in your ``origin``
Now your local ``main`` branch and the ``main`` branch in your ``origin``
repo have been updated with the most recent changes from the main pip
repository.

Expand All @@ -187,10 +187,10 @@ To keep your branches updated, the process is similar:
git checkout awesome-feature
git fetch upstream
git rebase upstream/master
git rebase upstream/main
Now your branch has been updated with the latest changes from the
``master`` branch on the upstream pip repository.
``main`` branch on the upstream pip repository.

It's good practice to back up your branches by pushing them to your
``origin`` on GitHub as you are working on them. To push a branch,
Expand Down Expand Up @@ -230,7 +230,7 @@ If you get an error message like this:
Try force-pushing your branch with ``push -f``.

The ``master`` branch in the main pip repository gets updated frequently, so
The ``main`` branch in the main pip repository gets updated frequently, so
you might have to update your branch at least once while you are working on it.

Thank you for your contribution!
Expand Down Expand Up @@ -267,9 +267,9 @@ will initiate a vote among the existing maintainers.
.. _`Travis CI`: https://travis-ci.org/
.. _`Azure Pipelines`: https://azure.microsoft.com/en-in/services/devops/pipelines/
.. _`GitHub Actions`: https://github.com/features/actions
.. _`.travis.yml`: https://github.com/pypa/pip/blob/master/.travis.yml
.. _`.azure-pipelines`: https://github.com/pypa/pip/blob/master/.azure-pipelines
.. _`.github/workflows`: https://github.com/pypa/pip/blob/master/.github/workflows
.. _`.travis.yml`: https://github.com/pypa/pip/blob/main/.travis.yml
.. _`.azure-pipelines`: https://github.com/pypa/pip/blob/main/.azure-pipelines
.. _`.github/workflows`: https://github.com/pypa/pip/blob/main/.github/workflows
.. _`CI Documentation`: https://pip.pypa.io/en/latest/development/ci/
.. _`towncrier`: https://pypi.org/project/towncrier/
.. _`Testing the next-gen pip dependency resolver`: https://pradyunsg.me/blog/2020/03/27/pip-resolver-testing/
4 changes: 2 additions & 2 deletions docs/html/development/issue-triage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ Examples:
(`link <https://github.com/pypa/pip/issues/6498#issuecomment-513501112>`__)
- get-pip on system with no ``/usr/lib64``
(`link <https://github.com/pypa/pip/issues/5379#issuecomment-515270576>`__)
- reproducing with ``pip`` from master branch
- reproducing with ``pip`` from current development branch
(`link <https://github.com/pypa/pip/issues/6707#issue-467770959>`__)


Expand Down Expand Up @@ -285,7 +285,7 @@ An issue may be considered resolved and closed when:
- already tracked by another issue

- A project-specific issue has been identified and the issue no
longer occurs as of the latest commit on the master branch.
longer occurs as of the latest commit on the main branch.

- An enhancement or feature request no longer has a proponent and the maintainers
don't think it's worth keeping open.
Expand Down
22 changes: 11 additions & 11 deletions docs/html/development/release-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Release process
Release Cadence
===============

The pip project has a release cadence of releasing whatever is on ``master``
The pip project has a release cadence of releasing whatever is on ``main``
every 3 months. This gives users a predictable pattern for when releases
are going to happen and prevents locking up improvements for fixes for long
periods of time, while still preventing massively fracturing the user base
Expand All @@ -22,8 +22,8 @@ The release manager may, at their discretion, choose whether or not there
will be a pre-release period for a release, and if there is may extend that
period into the next month if needed.

Because releases are made direct from the ``master`` branch, it is essential
that ``master`` is always in a releasable state. It is acceptable to merge
Because releases are made direct from the ``main`` branch, it is essential
that ``main`` is always in a releasable state. It is acceptable to merge
PRs that partially implement a new feature, but only if the partially
implemented version is usable in that state (for example, with reduced
functionality or disabled by default). In the case where a merged PR is found
Expand Down Expand Up @@ -116,13 +116,13 @@ Release Process
Creating a new release
----------------------

#. Checkout the current pip ``master`` branch.
#. Checkout the current pip ``main`` branch.
#. Ensure you have the latest ``nox`` installed.
#. Prepare for release using ``nox -s prepare-release -- YY.N``.
This will update the relevant files and tag the correct commit.
#. Build the release artifacts using ``nox -s build-release -- YY.N``.
This will checkout the tag, generate the distribution files to be
uploaded and checkout the master branch again.
uploaded and checkout the main branch again.
#. Upload the release to PyPI using ``nox -s upload-release -- YY.N``.
#. Push all of the changes including the tag.
#. Regenerate the ``get-pip.py`` script in the `get-pip repository`_ (as
Expand Down Expand Up @@ -155,20 +155,20 @@ Creating a bug-fix release

Sometimes we need to release a bugfix release of the form ``YY.N.Z+1``. In
order to create one of these the changes should already be merged into the
``master`` branch.
``main`` branch.

#. Create a new ``release/YY.N.Z+1`` branch off of the ``YY.N`` tag using the
command ``git checkout -b release/YY.N.Z+1 YY.N``.
#. Cherry pick the fixed commits off of the ``master`` branch, fixing any
#. Cherry pick the fixed commits off of the ``main`` branch, fixing any
conflicts.
#. Run ``nox -s prepare-release -- YY.N.Z+1``.
#. Merge master into your release branch and drop the news files that have been
#. Merge main into your release branch and drop the news files that have been
included in your release (otherwise they would also appear in the ``YY.N+1``
changelog)
#. Push the ``release/YY.N.Z+1`` branch to github and submit a PR for it against
the ``master`` branch and wait for the tests to run.
#. Once tests run, merge the ``release/YY.N.Z+1`` branch into master, and follow
the above release process starting with step 4.
the ``main`` branch and wait for the tests to run.
#. Once tests run, merge the ``release/YY.N.Z+1`` branch into ``main``, and
follow the above release process starting with step 4.

.. _`get-pip repository`: https://github.com/pypa/get-pip
.. _`psf-salt repository`: https://github.com/python/psf-salt
Expand Down
6 changes: 3 additions & 3 deletions docs/html/reference/pip_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ Here are the supported forms::

Passing a branch name, a commit hash, a tag name or a git ref is possible like so::

[-e] git+https://git.example.com/MyProject.git@master#egg=MyProject
[-e] git+https://git.example.com/MyProject.git@main#egg=MyProject
[-e] git+https://git.example.com/MyProject.git@v1.0#egg=MyProject
[-e] git+https://git.example.com/MyProject.git@da39a3ee5e6b4b0d3255bfef95601890afd80709#egg=MyProject
[-e] git+https://git.example.com/MyProject.git@refs/pull/123/head#egg=MyProject
Expand Down Expand Up @@ -1062,7 +1062,7 @@ Examples
.. code-block:: shell
python -m pip install SomePackage[PDF]
python -m pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@master#subdirectory=subdir_path"
python -m pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@main#subdirectory=subdir_path"
python -m pip install .[PDF] # project in current directory
python -m pip install SomePackage[PDF]==3.0
python -m pip install SomePackage[PDF,EPUB] # multiple extras
Expand All @@ -1072,7 +1072,7 @@ Examples
.. code-block:: shell
py -m pip install SomePackage[PDF]
py -m pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@master#subdirectory=subdir_path"
py -m pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@main#subdirectory=subdir_path"
py -m pip install .[PDF] # project in current directory
py -m pip install SomePackage[PDF]==3.0
py -m pip install SomePackage[PDF,EPUB] # multiple extras
Expand Down
2 changes: 1 addition & 1 deletion docs/html/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1887,6 +1887,6 @@ announcements on the `low-traffic packaging announcements list`_ and
.. _low-traffic packaging announcements list: https://mail.python.org/mailman3/lists/pypi-announce.python.org/
.. _our survey on upgrades that create conflicts: https://docs.google.com/forms/d/e/1FAIpQLSeBkbhuIlSofXqCyhi3kGkLmtrpPOEBwr6iJA6SzHdxWKfqdA/viewform
.. _the official Python blog: https://blog.python.org/
.. _requests: https://requests.readthedocs.io/en/master/user/authentication/#netrc-authentication
.. _requests: https://requests.readthedocs.io/en/latest/user/authentication/#netrc-authentication
.. _Python standard library: https://docs.python.org/3/library/netrc.html
.. _Python Windows launcher: https://docs.python.org/3/using/windows.html#launcher

0 comments on commit 7ec0fa5

Please sign in to comment.