Document that care needs to be taken with any_streams_attached.

diff --git a/src/or/or.h b/src/or/or.h
index 8501235b7b470fe7f220c52fbae65c15fac00a1e..d165705e9711ea3ba82ee9804400984f4e470930 100644 (file)
--- 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;