another pullup (SoupLogger docs)

svn path=/branches/gnome-2-24/; revision=1208

2 files changed, 17 insertions, 0 deletions

diff --git a/ChangeLog b/ChangeLog
index 74f2efd0..ab46489e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2008-11-24  Dan Winship  <danw@gnome.org>
+
+	* libsoup/soup-logger.c: clarify exactly when stuff gets logged
+	(and in particular, that SoupSession::authenticate gets emitted
+	before the response it is authenticating gets logged).
+
 2008-11-04  Dan Winship  <danw@gnome.org>
 
 	* docs/reference/Makefile.am (SCAN_OPTIONS): set
diff --git a/libsoup/soup-logger.c b/libsoup/soup-logger.c
index 37b9fec9..bb984411 100644
--- a/libsoup/soup-logger.c
+++ b/libsoup/soup-logger.c
@@ -66,6 +66,17 @@
  * across the lifetime of the #SoupLogger. In particular, this can be
  * used to identify when multiple messages are sent across the same
  * connection.
+ *
+ * The request half of the message is logged just before the first
+ * byte of the request gets written to the network (from the
+ * #SoupSession::request_started signal), and the response is logged
+ * just after the last byte of the response body is read from the
+ * network (from the #SoupMessage::got_body or
+ * #SoupMessage::got_informational signal). In particular, note that
+ * the #SoupMessage::got_headers signal, and anything triggered off it
+ * (such as #SoupSession::authenticate) will be emitted
+ * <emphasis>before</emphasis> the response headers are actually
+ * logged.
  **/
 
 static void soup_logger_session_feature_init (SoupSessionFeatureInterface *feature_interface, gpointer interface_data);