Trivial: replace "Tor's control socket API" with "Tor's control protocol API" #14243

pull emilrus wants to merge 2 commits into bitcoin:master from emilrus:master changing 1 files +1 −1

emilrus commented at 2:56 PM on September 17, 2018: none

The use of control socket can create confusion as seen in #13397

control port is more appropriate in this instance https://gitweb.torproject.org/torspec.git/tree/control-spec.txt
Replace "control socket" with "control protocol" 425a08189e
fanquake added the label Docs on Sep 17, 2018

in doc/tor.md:91 in 425a08189e outdated

  87 | @@ -88,7 +88,7 @@ for normal IPv4/IPv6 communication, use:
  88 |  
  89 |  ## 3. Automatically listen on Tor
  90 |  
  91 | -Starting with Tor version 0.2.7.1 it is possible, through Tor's control socket
  92 | +Starting with Tor version 0.2.7.1 it is possible, through Tor's control protocol

fanquake commented at 10:00 PM on September 17, 2018:

Please remove the trailing whitespace

practicalswift commented at 5:11 AM on September 18, 2018:

2018-09-17 17:56:07 mdl(pr=14243): doc/tor.md:91: MD009 Trailing spaces

Remove trailing space 056e9286b3
laanwj commented at 12:20 PM on September 19, 2018: member

A TCP socket ("network socket") is also a socket. To be precise, the "Tor control protocol" runs over a socket, which can be of different types. On Windows this only supports network sockets, on UNIX it can use a local socket.

To be honest, I'd prefer to add UNIX socket support instead, if you think that results in confusing. I don't think changing this word is worth it.
laanwj closed this on Sep 19, 2018
emilrus commented at 2:14 PM on September 19, 2018: none

@laanwj agree on the use of word socket however this is a different scenario It is the control protocol of tor that has an API, the control socket is just a socket through which the control protocol is used. It is akin to saying RPC API instead of Bitcoin API because you're using the API through RPC.

It is just a nit and I don't care either way but I think it should be changed for rigorousness.
I also subscribe to having unix socket support added to Bitcoin's tor control given that Debian comes with it by default and has tcp sockets disabled.
DrahtBot locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#13397 tor: Error connecting to Tor control socket