diff options
| author | William Woodruff <william@trailofbits.com> | 2022-12-02 21:12:47 -0800 |
|---|---|---|
| committer | William Woodruff <william@trailofbits.com> | 2022-12-02 21:12:47 -0800 |
| commit | 3b9abbc9872381ffe2c79f0fc0fe5f5b6b06d61a (patch) | |
| tree | d8ce8da79716df2abeab10caf02a47ae9f5eb7e5 /docs | |
| parent | 61205c1fe3e903fd55d5ab29442109b359ec9819 (diff) | |
| download | pip-3b9abbc9872381ffe2c79f0fc0fe5f5b6b06d61a.tar.gz | |
topics/vcs-support: re-qualify egg fragment behavior
Signed-off-by: William Woodruff <william@trailofbits.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/html/topics/vcs-support.md | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/docs/html/topics/vcs-support.md b/docs/html/topics/vcs-support.md index af1ebffcf..d108f4d82 100644 --- a/docs/html/topics/vcs-support.md +++ b/docs/html/topics/vcs-support.md @@ -141,11 +141,9 @@ pip looks at 2 fragments for VCS URLs: - `egg`: For specifying the "project name" for use in pip's dependency resolution logic. e.g.: `egg=project_name` - The `egg` fragment may additionally contain an extras specifier, e.g.: - `egg=project_name[dev,test]`. - - Both the project name and extras specifier must appear in the form - defined by [PEP 508](https://peps.python.org/pep-0508/). + The `egg` fragment **should** be a bare + [PEP 508](https://peps.python.org/pep-0508/) project name. Anything else + is not guaranteed to work. - `subdirectory`: For specifying the path to the Python package, when it is not in the root of the VCS directory. e.g.: `pkg_dir` |