Skip to content

Commit ba44cc2

Browse files
committed
Add feature flag documentation
1 parent 9ec3cfa commit ba44cc2

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/html/development/release-process.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,33 @@ only bugs will be considered, and merged (subject to normal review processes).
7171
Note that there may be delays due to the lack of developer resources for
7272
reviewing such pull requests.
7373

74+
Feature Flags
75+
=============
76+
77+
``--use-deprecated``
78+
--------------------
79+
80+
Example: ``--use-deprecated=legacy-resolver``
81+
82+
Use for features that will be deprecated. Deprecated features should remain
83+
available behind this flag for at least six months, as per the deprecation
84+
policy.
85+
86+
Features moved behind this flag should always include a warning that indicates
87+
when the feature is scheduled to be removed.
88+
89+
Once the feature is removed, user's who use the flag should be shown an error.
90+
91+
``--use-feature``
92+
-----------------
93+
94+
Example: ``--use-feature=2020-resolver``
95+
96+
Use for new features that users can test before they become pip's default
97+
behaviour (e.g. alpha or beta releases).
98+
99+
Once the feature becomes the default behaviour, this flag can remain in place,
100+
but should issue a warning telling the user that it is no longer necessary.
74101

75102
Release Process
76103
===============

news/8512.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add feature flags to docs

0 commit comments

Comments
 (0)