Skip to content

Commit b461de8

Browse files
authored
Merge pull request #1423 from larsoner/record
DOC: Document RECORD modification
2 parents ad04323 + 6d8be68 commit b461de8

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

source/specifications/recording-installed-packages.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,15 @@ attempt to uninstall or upgrade the package.
175175
(This restriction does not apply to tools that rely on other sources of information,
176176
such as system package managers in Linux distros.)
177177

178+
.. note::
179+
180+
It is *strongly discouraged* for an installed package to modify itself
181+
(e.g., store cache files under its namespace in ``site-packages``).
182+
Changes inside ``site-packages`` should be left to specialized installer
183+
tools such as pip. If a package is nevertheless modified in this way,
184+
then the ``RECORD`` must be updated, otherwise uninstalling the package
185+
will leave unlisted files in place (possibly resulting in a zombie
186+
namespace package).
178187

179188
The INSTALLER file
180189
==================

0 commit comments

Comments
 (0)