Add a bunch of new comments to explain connection_ap_rewrite{,_and_attach}

Also, do a little light refactoring to move some variable declarations
around and make a few things const

Also fix an obnoxious bug on checking for the DONE stream end reason.
It's not a flag; it's a possible value or a variable that needs to be
masked.

1 files changed, 2 insertions, 2 deletions

diff --git a/src/or/connection_edge.h b/src/or/connection_edge.h
index d4a20e7f96..0cc391ed82 100644
--- a/src/or/connection_edge.h
+++ b/src/or/connection_edge.h
@@ -151,8 +151,8 @@ typedef struct {
    */
   char orig_address[MAX_SOCKS_ADDR_LEN];
   /** True iff the address has been automatically remapped to a local
-   * address in VirtualAddrNetwork.  (Only set true the first time we
-   * do the mapping.) */
+   * address in VirtualAddrNetwork.  (Only set true when we do a resolve
+   * and get a virtual address; not when we connect to the address.) */
   int automap;
   /** If this connection has a .exit address, who put it there? */
   addressmap_entry_source_t exit_source;