transport: update registration docsethomson/transport_register_docs
authorEdward Thomson <[email protected]>
Fri, 6 Jun 2025 20:18:51 +0000 (6 21:18 +0100)
committerEdward Thomson <[email protected]>
Fri, 6 Jun 2025 20:18:51 +0000 (6 21:18 +0100)
The documentation for `git_transport_register` erroneously stated that
the trailing `://` was required for the scheme. It is not.

include/git2/sys/transport.h

index ad6765c..6a19024 100644 (file)
@@ -206,7 +206,7 @@ GIT_EXTERN(int) git_transport_ssh_with_paths(git_transport **out, git_remote *ow
  * and git_transport_unregister with other calls to the library that
  * instantiate transports.
  *
- * @param prefix The scheme (ending in "://") to match, i.e. "git://"
+ * @param prefix The scheme to match, eg "git" or "https"
  * @param cb The callback used to create an instance of the transport
  * @param param A fixed parameter to pass to cb at creation time
  * @return 0 or an error code