[tor-commits] [tor/master] Document that care needs to be taken with any_streams_attached.

[nickm at torproject.org]

commit 9b4046607232c636c58f04672c1b762968a8b023
Author: Mike Perry <mikeperry-git at fscked.org>
Date:   Wed Nov 21 16:31:58 2012 -0800

    Document that care needs to be taken with any_streams_attached.
---
 src/or/or.h |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/src/or/or.h b/src/or/or.h
index 8501235..d165705 100644
--- a/src/or/or.h
+++ b/src/or/or.h
@@ -2875,6 +2875,10 @@ typedef struct origin_circuit_t {
   /**
    * Did any SOCKS streams or hidserv introductions actually succeed on
    * this circuit?
+   *
+   * Note: If we ever implement end-to-end stream timing through test
+   * stream probes (#5707), we must *not* set this for those probes
+   * (or any other automatic streams).
    */
   unsigned int any_streams_succeeded : 1;