Skip to content

Commit f61e452

Browse files
committed
Document the incorrect behavior revealed by #4167.
1 parent 4aa55b8 commit f61e452

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/deprecated/python_eggs.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,14 @@ Python version, or platform information is included. When the runtime
193193
searches for available eggs, ``.egg-link`` files are opened and the
194194
actual egg file/directory name is read from them.
195195

196+
Note: Due to `pypa/setuptools#4167
197+
<https://github.com/pypa/setuptools/issues/4167>`_, the name in the egg-link
198+
filename does not match the filename components used in similar files, but
199+
instead presents with dash separators instead of underscore separators. For
200+
compatibility with pip prior to version 24.0, these dash separators are
201+
retained. In a future release, pip 24 or later will be required and the
202+
underscore separators will be used.
203+
196204
Each ``.egg-link`` file should contain a single file or directory name,
197205
with no newlines. This filename should be the base location of one or
198206
more eggs. That is, the name must either end in ``.egg``, or else it

0 commit comments

Comments
 (0)