Skip to content

Commit e666842

Browse files
authored
Merge pull request #10699 from cpawley/update-docs-10627
2 parents 3ba7c81 + 5b6b421 commit e666842

File tree

2 files changed

+28
-27
lines changed

2 files changed

+28
-27
lines changed

docs/html/topics/vcs-support.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ The supported schemes are `git+file`, `git+https`, `git+ssh`, `git+http`,
1717
`git+git` and `git`. Here are some of the supported forms:
1818

1919
```none
20-
git+ssh://git.example.com/MyProject#egg=MyProject
21-
git+file:///home/user/projects/MyProject#egg=MyProject
22-
git+https://git.example.com/MyProject#egg=MyProject
20+
MyProject @ git+ssh://git.example.com/MyProject
21+
MyProject @ git+file:///home/user/projects/MyProject
22+
MyProject @ git+https://git.example.com/MyProject
2323
```
2424

2525
```{warning}
@@ -34,10 +34,10 @@ It is also possible to specify a "git ref" such as branch name, a commit hash or
3434
a tag name:
3535

3636
```none
37-
git+https://git.example.com/MyProject.git@master#egg=MyProject
38-
git+https://git.example.com/[email protected]#egg=MyProject
39-
git+https://git.example.com/MyProject.git@da39a3ee5e6b4b0d3255bfef95601890afd80709#egg=MyProject
40-
git+https://git.example.com/MyProject.git@refs/pull/123/head#egg=MyProject
37+
MyProject @ git+https://git.example.com/MyProject.git@master
38+
MyProject @ it+https://git.example.com/[email protected]
39+
MyProject @ git+https://git.example.com/MyProject.git@da39a3ee5e6b4b0d3255bfef95601890afd80709
40+
MyProject @ git+https://git.example.com/MyProject.git@refs/pull/123/head
4141
```
4242

4343
When passing a commit hash, specifying a full hash is preferable to a partial
@@ -50,20 +50,20 @@ The supported schemes are `hg+file`, `hg+http`, `hg+https`, `hg+ssh`
5050
and `hg+static-http`. Here are some of the supported forms:
5151

5252
```
53-
hg+http://hg.myproject.org/MyProject#egg=MyProject
54-
hg+https://hg.myproject.org/MyProject#egg=MyProject
55-
hg+ssh://hg.myproject.org/MyProject#egg=MyProject
56-
hg+file:///home/user/projects/MyProject#egg=MyProject
53+
MyProject @ hg+http://hg.myproject.org/MyProject
54+
MyProject @ hg+https://hg.myproject.org/MyProject
55+
MyProject @ hg+ssh://hg.myproject.org/MyProject
56+
MyProject @ hg+file:///home/user/projects/MyProject
5757
```
5858

5959
It is also possible to specify a revision number, a revision hash, a tag name
6060
or a local branch name:
6161

6262
```none
63-
hg+http://hg.example.com/MyProject@da39a3ee5e6b#egg=MyProject
64-
hg+http://hg.example.com/MyProject@2019#egg=MyProject
65-
hg+http://hg.example.com/[email protected]#egg=MyProject
66-
hg+http://hg.example.com/MyProject@special_feature#egg=MyProject
63+
MyProject @ hg+http://hg.example.com/MyProject@da39a3ee5e6b
64+
MyProject @ hg+http://hg.example.com/MyProject@2019
65+
MyProject @ hg+http://hg.example.com/[email protected]
66+
MyProject @ hg+http://hg.example.com/MyProject@special_feature
6767
```
6868

6969
### Subversion
@@ -72,16 +72,16 @@ The supported schemes are `svn`, `svn+svn`, `svn+http`, `svn+https` and
7272
`svn+ssh`. Here are some of the supported forms:
7373

7474
```none
75-
svn+https://svn.example.com/MyProject#egg=MyProject
76-
svn+ssh://svn.example.com/MyProject#egg=MyProject
77-
svn+ssh://[email protected]/MyProject#egg=MyProject
75+
MyProject @svn+https://svn.example.com/MyProject
76+
MyProject @svn+ssh://svn.example.com/MyProject
77+
MyProject @svn+ssh://[email protected]/MyProject
7878
```
7979

8080
You can also give specific revisions to an SVN URL, like so:
8181

8282
```none
83-
-e svn+http://svn.example.com/svn/MyProject/trunk@2019#egg=MyProject
84-
-e svn+http://svn.example.com/svn/MyProject/trunk@{20080101}#egg=MyProject
83+
MyProject @ -e svn+http://svn.example.com/svn/MyProject/trunk@2019
84+
MyProject @ -e svn+http://svn.example.com/svn/MyProject/trunk@{20080101}
8585
```
8686

8787
Note that you need to use [Editable VCS installs](#editable-vcs-installs) for
@@ -93,18 +93,18 @@ The supported schemes are `bzr+http`, `bzr+https`, `bzr+ssh`, `bzr+sftp`,
9393
`bzr+ftp` and `bzr+lp`. Here are the supported forms:
9494

9595
```none
96-
bzr+http://bzr.example.com/MyProject/trunk#egg=MyProject
97-
bzr+sftp://[email protected]/MyProject/trunk#egg=MyProject
98-
bzr+ssh://[email protected]/MyProject/trunk#egg=MyProject
99-
bzr+ftp://[email protected]/MyProject/trunk#egg=MyProject
100-
bzr+lp:MyProject#egg=MyProject
96+
MyProject @ bzr+http://bzr.example.com/MyProject/trunk
97+
MyProject @ bzr+sftp://[email protected]/MyProject/trunk
98+
MyProject @ bzr+ssh://[email protected]/MyProject/trunk
99+
MyProject @ bzr+ftp://[email protected]/MyProject/trunk
100+
MyProject @ bzr+lp:MyProject
101101
```
102102

103103
Tags or revisions can be installed like so:
104104

105105
```none
106-
bzr+https://bzr.example.com/MyProject/trunk@2019#egg=MyProject
107-
bzr+http://bzr.example.com/MyProject/[email protected]#egg=MyProject
106+
MyProject @ bzr+https://bzr.example.com/MyProject/trunk@2019
107+
MyProject @ bzr+http://bzr.example.com/MyProject/[email protected]
108108
```
109109

110110
(editable-vcs-installs)=

news/10627.trivial.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Docs reflect the new method of accessing VCS packages

0 commit comments

Comments
 (0)