packfile/client: add note about supported schemes

gg-scm · Jan 27, 2021 · 080055d · 080055d
1 parent 8dafa6b
commit 080055d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packfile/client/client.go b/packfile/client/client.go
@@ -74,6 +74,11 @@ func (opts *Options) httpUserAgent() string {
 
 // NewRemote returns a new Remote or returns an error if the transport specified
 // in the URL scheme is unsupported.
+//
+// The supported schemes are:
+//
+//   file: Local git-upload-pack/git-receive-pack subprocesses
+//   http/https: Smart Git HTTP protocol
 func NewRemote(u *url.URL, opts *Options) (*Remote, error) {
 	urlstr := u.Redacted()
 	remote := &Remote{