[tor-commits] [tor/master] Fix minor comment issues

nickm at torproject.org nickm at torproject.org
Fri Jun 24 20:50:18 UTC 2011


commit d7254bea11a0fc2685cc2ea24fb57d2ab3945b2f
Author: Robert Ransom <rransom.8774 at gmail.com>
Date:   Sun Jun 19 01:28:40 2011 -0700

    Fix minor comment issues
---
 src/common/compat.c  |    2 +-
 src/or/connection.c  |    6 +++---
 src/or/or.h          |    6 +++---
 src/test/Makefile.am |    2 +-
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/common/compat.c b/src/common/compat.c
index 9377959..c983925 100644
--- a/src/common/compat.c
+++ b/src/common/compat.c
@@ -415,7 +415,7 @@ tor_vasprintf(char **strp, const char *fmt, va_list args)
  *
  * This function is <em>not</em> timing-safe.
  *
- * Requires that nlen be greater than zero.
+ * Requires that <b>nlen</b> be greater than zero.
  */
 const void *
 tor_memmem(const void *_haystack, size_t hlen,
diff --git a/src/or/connection.c b/src/or/connection.c
index a9e3a74..b2412a2 100644
--- a/src/or/connection.c
+++ b/src/or/connection.c
@@ -2751,15 +2751,15 @@ connection_outbuf_too_full(connection_t *conn)
   return (conn->outbuf_flushlen > 10*CELL_PAYLOAD_SIZE);
 }
 
-/** Try to flush more bytes onto conn-\>s.
+/** Try to flush more bytes onto <b>conn</b>-\>s.
  *
  * This function gets called either from conn_write() in main.c
  * when poll() has declared that conn wants to write, or below
  * from connection_write_to_buf() when an entire TLS record is ready.
  *
- * Update conn-\>timestamp_lastwritten to now, and call flush_buf
+ * Update <b>conn</b>-\>timestamp_lastwritten to now, and call flush_buf
  * or flush_buf_tls appropriately. If it succeeds and there are no more
- * more bytes on conn->outbuf, then call connection_finished_flushing
+ * more bytes on <b>conn</b>-\>outbuf, then call connection_finished_flushing
  * on it too.
  *
  * If <b>force</b>, then write as many bytes as possible, ignoring bandwidth
diff --git a/src/or/or.h b/src/or/or.h
index 97fecd1..1909887 100644
--- a/src/or/or.h
+++ b/src/or/or.h
@@ -2318,14 +2318,14 @@ typedef struct or_circuit_t {
   cell_ewma_t p_cell_ewma;
 } or_circuit_t;
 
-/** Convert a circuit subtype to a circuit_t.*/
+/** Convert a circuit subtype to a circuit_t. */
 #define TO_CIRCUIT(x)  (&((x)->_base))
 
-/** Convert a circuit_t* to a pointer to the enclosing or_circuit_t.  Asserts
+/** Convert a circuit_t* to a pointer to the enclosing or_circuit_t.  Assert
  * if the cast is impossible. */
 static or_circuit_t *TO_OR_CIRCUIT(circuit_t *);
 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
- * Asserts if the cast is impossible. */
+ * Assert if the cast is impossible. */
 static origin_circuit_t *TO_ORIGIN_CIRCUIT(circuit_t *);
 
 static INLINE or_circuit_t *TO_OR_CIRCUIT(circuit_t *x)
diff --git a/src/test/Makefile.am b/src/test/Makefile.am
index 546fa2f..904719d 100644
--- a/src/test/Makefile.am
+++ b/src/test/Makefile.am
@@ -8,7 +8,7 @@ AM_CPPFLAGS = -DSHARE_DATADIR="\"$(datadir)\"" \
 	-I"$(top_srcdir)/src/or"
 
 # -L flags need to go in LDFLAGS. -l flags need to go in LDADD.
-# This seems to matter nowhere but on windows, but I assure you that it
+# This seems to matter nowhere but on Windows, but I assure you that it
 # matters a lot there, and is quite hard to debug if you forget to do it.
 
 test_SOURCES = \





More information about the tor-commits mailing list