summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTzu-ping Chung <uranusjr@gmail.com>2022-11-16 12:50:52 +0800
committerGitHub <noreply@github.com>2022-11-16 12:50:52 +0800
commit4a87ab04c83aad4d2955e9e3e82ac2dd83d3cef9 (patch)
treec66321ca68909d2fda5363fc2b7d24bf2bfbf87a /docs
parentb777bcda819961092ae87ca7512e0b27c576d19c (diff)
parent9aa422da16e11b8e56d3597f34551f983ba9fbfd (diff)
downloadpip-4a87ab04c83aad4d2955e9e3e82ac2dd83d3cef9.tar.gz
Merge branch 'main' into feature/base-prefix-config
Diffstat (limited to 'docs')
-rw-r--r--docs/html/development/release-process.rst21
-rw-r--r--docs/html/topics/caching.md2
2 files changed, 22 insertions, 1 deletions
diff --git a/docs/html/development/release-process.rst b/docs/html/development/release-process.rst
index 188d3e87b..a9ae8465e 100644
--- a/docs/html/development/release-process.rst
+++ b/docs/html/development/release-process.rst
@@ -31,6 +31,15 @@ to need extra work before being released, the release manager always has the
option to back out the partial change prior to a release. The PR can then be
reworked and resubmitted for the next release.
+Vendoring updates will be picked up fron the ``main`` branch, as for any other
+update. Ideally, vendoring updates should be merged between releases, just like
+any other change. If there are outstanding updates to vendored packages, the
+release manager *may* at their discretion choose to do a vendoring update
+before the release. However this is *not* a requirement and in particular,
+updates to vendored packages that fix issues in pip should be merged
+proactively, to ensure that they will be present in the next release.
+
+
.. _`Deprecation Policy`:
Deprecation Policy
@@ -65,6 +74,13 @@ their merits.
``pip._internal.utils.deprecation.deprecated``. The function is not a part of
pip's public API.
+Supported Versions
+==================
+
+The latest version of the pip is the only supported version, previous
+versions should be considered unsupported. Users are encouraged to make
+regular updates to their version of pip in order to remain supported.
+
.. _`Python 2 Support`:
Python 2 Support
@@ -159,6 +175,11 @@ 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
``main`` branch.
+Note that this process is only needed when there are changes on the main branch
+that you do *not* want to include in the bugfix release. For a bugfix release
+that will include everything that is on the ``main`` branch, the above process
+for creating a new release can be used, simply changing the version number.
+
#. 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 ``main`` branch, fixing any
diff --git a/docs/html/topics/caching.md b/docs/html/topics/caching.md
index 351f960a6..d1a3f5ea1 100644
--- a/docs/html/topics/caching.md
+++ b/docs/html/topics/caching.md
@@ -140,6 +140,6 @@ The {ref}`pip cache` command can be used to manage pip's cache.
pip's caching behaviour is disabled by passing the `--no-cache-dir` option.
-It is, however, recommended to **NOT** disable pip's caching. Doing so can
+It is, however, recommended to **NOT** disable pip's caching unless you have caching at a higher level (eg: layered caches in container builds). Doing so can
significantly slow down pip (due to repeated operations and package builds)
and result in significantly more network usage.