From: Austin Clements <amdragon@MIT.EDU>
To: notmuch@notmuchmail.org
Subject: [PATCH 3/6] reply: Document the reason for g_mime_filter_headers
Date: Mon, 12 Aug 2013 14:40:36 -0400
Message-Id: <1376332839-22825-4-git-send-email-amdragon@mit.edu>
In-Reply-To: <1376332839-22825-1-git-send-email-amdragon@mit.edu>
References: <1376332839-22825-1-git-send-email-amdragon@mit.edu>
Precedence: list

Given how long it took me to figure out why we pass the reply headers
through g_mime_filter_headers, it's worth a comment.
---
 notmuch-reply.c |    4 ++++
 1 file changed, 4 insertions(+)

diff --git a/notmuch-reply.c b/notmuch-reply.c
index e151f78..3b2b58d 100644
--- a/notmuch-reply.c
+++ b/notmuch-reply.c
@@ -34,6 +34,10 @@ show_reply_headers (GMimeMessage *message)
 	g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
 	stream_filter = g_mime_stream_filter_new(stream_stdout);
 	if (stream_filter) {
+		// g_mime_object_write_to_stream will produce
+		// RFC2047-encoded headers, but we want to present the
+		// user with decoded headers and let whatever
+		// ultimately sends the mail do the RFC2047 encoding.
 		g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
 					 g_mime_filter_headers_new());
 		g_mime_object_write_to_stream(GMIME_OBJECT(message), stream_filter);
-- 
1.7.10.4