docs: update documentation for timeout

ethomson · ethomson · commit c3dc87b0c80e · 2024-02-05T10:16:17.000Z
The connect timeout *does* apply to SSH connections (at least libssh2),
so update the documentation appropriately.
diff --git a/include/git2/common.h b/include/git2/common.h
@@ -490,10 +490,9 @@ typedef enum {
  *
  *   opts(GIT_OPT_SET_SERVER_CONNECT_TIMEOUT, int timeout)
  *      > Sets the timeout (in milliseconds) to attempt connections to
- *      > a remote server. This is supported only for HTTP(S) connections
- *      > and is not supported by SSH. Set to 0 to use the system default.
- *      > Note that this may not be able to be configured longer than the
- *      > system default, typically 75 seconds.
+ *      > a remote server. Set to 0 to use the system default. Note that
+ *      > this may not be able to be configured longer than the system
+ *      > default, typically 75 seconds.
  *
  *   opts(GIT_OPT_GET_SERVER_TIMEOUT, int *timeout)
  *      > Gets the timeout (in milliseconds) for reading from and writing

Original file line number	Diff line number	Diff line change
`@@ -490,10 +490,9 @@ typedef enum {`
`490`	`490`	`*`
`491`	`491`	`* opts(GIT_OPT_SET_SERVER_CONNECT_TIMEOUT, int timeout)`
`492`	`492`	`* > Sets the timeout (in milliseconds) to attempt connections to`
`493`		`- * > a remote server. This is supported only for HTTP(S) connections`
`494`		`- * > and is not supported by SSH. Set to 0 to use the system default.`
`495`		`- * > Note that this may not be able to be configured longer than the`
`496`		`- * 5858 > system default, typically 75 seconds.`
	`493`	`+ * > a remote server. Set to 0 to use the system default. Note that`
	`494`	`+ * > this may not be able to be configured longer than the system`
	`495`	`+ * > default, typically 75 seconds.`
`497`	`496`	`*`
`498`	`497`	`* opts(GIT_OPT_GET_SERVER_TIMEOUT, int *timeout)`
`499`	`498`	`* > Gets the timeout (in milliseconds) for reading from and writing`