diff options
| author | Karen Arutyunov <karen@codesynthesis.com> | 2018-11-07 21:25:52 +0300 |
|---|---|---|
| committer | Karen Arutyunov <karen@codesynthesis.com> | 2018-11-08 16:36:27 +0300 |
| commit | cc66b4c93bea20220de9ebd4a0b3f686da1d0453 (patch) | |
| tree | 7abc36a4236b410cd2a9ee350b52fef84ae7c35b /bpkg/repository-types.cli | |
| parent | dfabdad54e9a2fc15e37d0b407448390ea701f09 (diff) | |
Add support for ssh:// git protocol
Diffstat (limited to 'bpkg/repository-types.cli')
| -rw-r--r-- | bpkg/repository-types.cli | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/bpkg/repository-types.cli b/bpkg/repository-types.cli index f0e07be..79c50f8 100644 --- a/bpkg/repository-types.cli +++ b/bpkg/repository-types.cli @@ -155,11 +155,11 @@ plus (\cb{+}) is treated as an inclusion filter. For example: .../foo.git#++x - include +x \ -Currently supported \cb{git} protocols are \cb{git://}, \cb{http://}, and -\cb{https://} for remote repositories and \cb{file://} for local -repositories. While \cb{bpkg} tries to minimize the amount of information -(history) fetched, it is not always possible for some protocols and/or server -configurations, as discussed next. +Currently supported \cb{git} protocols are \cb{git://}, \cb{ssh://} (but not +\c{scp} pseudo-URL syntax), \cb{http://}, and \cb{https://} for remote +repositories and \cb{file://} for local repositories. While \cb{bpkg} tries to +minimize the amount of information (history) fetched, it is not always +possible for some protocols and/or server configurations, as discussed next. A \cb{git} repository accessible via \cb{http(s)://} can use either \i{dumb} or \i{smart} protocol (refer to the \cb{git} documentation for details). The @@ -173,11 +173,12 @@ whether the server is configured to allow fetching unadvertised commits. For details, refer to the \cb{uploadpack.allowReachableSHA1InWant} and \cb{uploadpack.allowAnySHA1InWant} \cb{git} configuration values. -The \cb{git://} protocol is similar to smart \cb{http://} in that it supports -fetching minimal history for tags and branches and may or may not support this -for commit ids depending on the server configuration. Note, however, that -unlike for \cb{http(s)://}, for this protocol \cb{bpkg} does not try to sense -if fetching unadvertised commits is allowed and always assumes that it is not. +The \cb{git://} and \cb{ssh://} protocols are similar to smart \cb{http://} in +that they support fetching minimal history for tags and branches and may or +may not support this for commit ids depending on the server configuration. +Note, however, that unlike for \cb{http(s)://}, for these protocols \cb{bpkg} +does not try to sense if fetching unadvertised commits is allowed and always +assumes that it is not. Based on this information, to achieve optimal results the recommended protocol for remote repositories is smart \cb{https://}. Additionally, if you are |