doc: TCPProxy is not supported in TOR_PT_PROXY

Because we need to construct the URI using the TCPProxy configuration
but we don't have a standard URI scheme for haproxy yet, we decided to
not support TCPProxy in TOR_PT_PROXY now. There is no problem with
HTTPSProxy, Socks4Proxy, or Socks5Proxy because they all have standard
URI schemes.

diff --git a/src/feature/client/transports.c b/src/feature/client/transports.c
index 97bfc8ae30671821d7c6cb3d98e596ef036f1819..de383c98360e0d5c5a115ebfde6b9b648fa72424 100644 (file)
--- a/src/feature/client/transports.c
+++ b/src/feature/client/transports.c
@@ -733,6 +733,9 @@ get_pt_proxy_uri(void)
   const or_options_t *options = get_options();
   char *uri = NULL;
 
+  /* XXX: Currently TCPProxy is not supported in TOR_PT_PROXY because
+   * there isn't a standard URI scheme for some proxy protocols, such as
+   * haproxy. */
   if (options->Socks4Proxy || options->Socks5Proxy || options->HTTPSProxy) {
     char addr[TOR_ADDR_BUF_LEN+1];