[tor-commits] [torspec/master] control-spec: Use TRANSPORT in PT_STATUS

[nickm at torproject.org]

commit a5e2dca209f4520261880d0baea689d3026c089f
Author: David Goulet <dgoulet at torproject.org>
Date:   Thu Jan 17 11:08:30 2019 -0500

    control-spec: Use TRANSPORT in PT_STATUS
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 control-spec.txt | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/control-spec.txt b/control-spec.txt
index c9c7d41..1259c60 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -3279,17 +3279,19 @@
 
     the resulting control port event would be:
 
-      Tor: 650 PT_LOG PT=/usr/bin/obfs4proxy SEVERITY=debug MESSAGE="Connected to bridge A"
+      Tor: 650 PT_LOG SEVERITY=debug MESSAGE="Connected to bridge A"
 
    [PT_LOG was added in Tor 0.4.0.1-alpha]
 
 4.1.29. Pluggable Transport Status
 
    Syntax:
-      "650" SP "PT_STATUS" SP PT=Program SP Message
+      "650" SP "PT_STATUS" SP PT=Program SP TRANSPORT=Transport SP Message
 
       Program = The program path as defined in the *TransportPlugin
                 configuration option. Tor accepts relative and full path.
+      Transport = This value indicate a hint on what the PT is such has the
+                  name or the protocol used for instance.
       Message = The status message that the PT sends back to the tor parent
                 process minus the "STATUS" string prefix. Formatted as
                 specified in pt-spec.txt section 3.3.5.
@@ -3298,11 +3300,11 @@
 
    Example:
 
-      PT (obfs4): STATUS TYPE=obfs4 CONNECT=Success
+      PT (obfs4): STATUS TRANSPORT=obfs4 CONNECT=Success
 
    the resulting control port event would be:
 
-      Tor: 650 PT_STATUS PT=/usr/bin/obfs4proxy TYPE=obfs4 CONNECT=Success
+      Tor: 650 PT_STATUS TRANSPORT=obfs4 CONNECT=Success
 
    [PT_STATUS was added in Tor 0.4.0.1-alpha]