[tor-commits] [stem/master] Document RawRelayCell in the module overview

[atagar at torproject.org]

commit 98398f6dbce3bca2f146d40abf3894ea2755e054
Author: Dave Rolek <dmr-x at riseup.net>
Date:   Thu Aug 9 19:18:13 2018 +0000

    Document RawRelayCell in the module overview
    
    The line is long, so this change also extends the vertically aligned
    table format for other Cell classes, in a forward-looking manner.
    
    Arguably this could've been part of the previous change, but it made
    sense to break it out for readability purposes.
---
 stem/client/cell.py | 39 ++++++++++++++++++++-------------------
 1 file changed, 20 insertions(+), 19 deletions(-)

diff --git a/stem/client/cell.py b/stem/client/cell.py
index 4f7aec79..f18318da 100644
--- a/stem/client/cell.py
+++ b/stem/client/cell.py
@@ -12,26 +12,27 @@ Messages communicated over a Tor relay's ORPort.
 
   Cell - Base class for ORPort messages.
     |- CircuitCell - Circuit management.
-    |  |- CreateCell - Create a circuit.              (section 5.1)
-    |  |- CreatedCell - Acknowledge create.           (section 5.1)
-    |  |- BaseRelayCell - End-to-end data; abstract.  (section 6.1)
-    |  |- RelayCell - End-to-end data.                (section 6.1)
-    |  |- DestroyCell - Stop using a circuit.         (section 5.4)
-    |  |- CreateFastCell - Create a circuit, no PK.   (section 5.1)
-    |  |- CreatedFastCell - Circuit created, no PK.   (section 5.1)
-    |  |- RelayEarlyCell - End-to-end data; limited.  (section 5.6)
-    |  |- Create2Cell - Extended CREATE cell.         (section 5.1)
-    |  +- Created2Cell - Extended CREATED cell.       (section 5.1)
+    |  |- CreateCell - Create a circuit.                                          (section 5.1)
+    |  |- CreatedCell - Acknowledge create.                                       (section 5.1)
+    |  |- BaseRelayCell - End-to-end data; abstract.                              (section 6.1)
+    |  |  +- RawRelayCell - End-to-end data. Payload not unpacked.                (section 5.5.2.1, 5.5.3)
+    |  |- RelayCell - End-to-end data.                                            (section 6.1)
+    |  |- DestroyCell - Stop using a circuit.                                     (section 5.4)
+    |  |- CreateFastCell - Create a circuit, no PK.                               (section 5.1)
+    |  |- CreatedFastCell - Circuit created, no PK.                               (section 5.1)
+    |  |- RelayEarlyCell - End-to-end data; limited.                              (section 5.6)
+    |  |- Create2Cell - Extended CREATE cell.                                     (section 5.1)
+    |  +- Created2Cell - Extended CREATED cell.                                   (section 5.1)
     |
-    |- PaddingCell - Padding negotiation.             (section 7.2)
-    |- VersionsCell - Negotiate proto version.        (section 4)
-    |- NetinfoCell - Time and address info.           (section 4.5)
-    |- PaddingNegotiateCell - Padding negotiation.    (section 7.2)
-    |- VPaddingCell - Variable-length padding.        (section 7.2)
-    |- CertsCell - Relay certificates.                (section 4.2)
-    |- AuthChallengeCell - Challenge value.           (section 4.3)
-    |- AuthenticateCell - Client authentication.      (section 4.5)
-    |- AuthorizeCell - Client authorization.          (not yet used)
+    |- PaddingCell - Padding negotiation.                                         (section 7.2)
+    |- VersionsCell - Negotiate proto version.                                    (section 4)
+    |- NetinfoCell - Time and address info.                                       (section 4.5)
+    |- PaddingNegotiateCell - Padding negotiation.                                (section 7.2)
+    |- VPaddingCell - Variable-length padding.                                    (section 7.2)
+    |- CertsCell - Relay certificates.                                            (section 4.2)
+    |- AuthChallengeCell - Challenge value.                                       (section 4.3)
+    |- AuthenticateCell - Client authentication.                                  (section 4.5)
+    |- AuthorizeCell - Client authorization.                                      (not yet used)
     |
     |- pack - encodes cell into bytes
     |- unpack - decodes series of cells