Skip to content

Commit

Permalink
Add feature flag documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nlhkabu committed Jul 8, 2020
1 parent 9ec3cfa commit f545473
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/html/development/release-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,33 @@ only bugs will be considered, and merged (subject to normal review processes).
Note that there may be delays due to the lack of developer resources for
reviewing such pull requests.

Feature Flags
=============

``--use-deprecated``
--------------------

Example: ``--use-deprecated=legacy-resolver``

Use for features that will be deprecated. Deprecated features should remain
available behind this flag for at least six months, as per the deprecation
policy.

Features moved behind this flag should always include a warning that indicates
when the feature is scheduled to be removed.

Once the feature is removed, user's who use the flag should be shown an error.

``--use-feature``
--------------------

Example: ``--use-feature=2020-resolver``

Use for new features that users can test before they become pip's default
behaviour (e.g. alpha or beta releases).

Once the feature becomes the default behaviour, this flag can remain in place,
but should issue a warning telling the user that it is no longer necessary.

Release Process
===============
Expand Down
1 change: 1 addition & 0 deletions news/8512.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add feature flags to docs

0 comments on commit f545473

Please sign in to comment.