Skip to content

Commit

Permalink
Add note about install/upgrade behavior to docs
Browse files Browse the repository at this point in the history
Towards pypa#8115.
  • Loading branch information
brainwane committed Oct 29, 2020
1 parent 92f9e77 commit e979486
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/html/development/architecture/upgrade-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
Options that control the installation process
=============================================

When installing packages, pip chooses a distribution file, and installs it in
the user's environment. There are many choices involved in deciding which file
to install, and these are controlled by a variety of options.
When installing packages, pip chooses a distribution file, and
installs it in the user's environment. There are many choices (which
are `still evolving`_) involved in deciding which file to install, and
these are controlled by a variety of options.


Controlling what gets installed
Expand Down Expand Up @@ -118,3 +119,6 @@ necessarily resolution or what gets installed.
``--constraint``

``--editable <LOCATION>``


.. _still evolving: https://github.com/pypa/pip/issues/8115
3 changes: 3 additions & 0 deletions docs/html/reference/pip_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ pip install has several stages:
3. Build wheels. All the dependencies that can be are built into wheels.
4. Install the packages (and uninstall anything being upgraded/replaced).

Note that ``pip install`` prefers to leave the installed version as-is
unless ``--upgrade`` is specified.

Argument Handling
-----------------

Expand Down

0 comments on commit e979486

Please sign in to comment.