diff options
| author | William Woodruff <william@trailofbits.com> | 2022-11-22 17:04:23 -0500 |
|---|---|---|
| committer | William Woodruff <william@trailofbits.com> | 2022-11-22 17:04:23 -0500 |
| commit | e26712616e774f5a8d4a732be1fcd281042d414a (patch) | |
| tree | 960084fb0f0da7f4168e948bef5adbca56c59678 /docs | |
| parent | 4af0984cc31bb62f207d3b1ce220d58b38010af4 (diff) | |
| download | pip-e26712616e774f5a8d4a732be1fcd281042d414a.tar.gz | |
topics/vcs-support: clarify the egg fragment's syntax
This doesn't actually address the semantics of extras in the
egg fragment.
Signed-off-by: William Woodruff <william@trailofbits.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/html/topics/vcs-support.md | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/html/topics/vcs-support.md b/docs/html/topics/vcs-support.md index 70bb5beb9..af1ebffcf 100644 --- a/docs/html/topics/vcs-support.md +++ b/docs/html/topics/vcs-support.md @@ -139,9 +139,16 @@ option. pip looks at 2 fragments for VCS URLs: - `egg`: For specifying the "project name" for use in pip's dependency - resolution logic. eg: `egg=project_name` + 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/). + - `subdirectory`: For specifying the path to the Python package, when it is not - in the root of the VCS directory. eg: `pkg_dir` + in the root of the VCS directory. e.g.: `pkg_dir` ````{admonition} Example If your repository layout is: |