[PATCH v4 1/5] sprinter: clarify separator documentation

diff --git a/71/3a902adef35a9c88d150d7692d244db0524ca7 b/71/3a902adef35a9c88d150d7692d244db0524ca7
new file mode 100644 (file)
index 0000000..b9f45b9
--- /dev/null
+++ b/71/3a902adef35a9c88d150d7692d244db0524ca7
@@ -0,0 +1,96 @@
+Return-Path: <jani@nikula.org>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 5C51E431FC3\r
+       for <notmuch@notmuchmail.org>; Sun, 16 Dec 2012 14:05:22 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id 6amFsM9PUseq for <notmuch@notmuchmail.org>;\r
+       Sun, 16 Dec 2012 14:05:21 -0800 (PST)\r
+Received: from mail-lb0-f181.google.com (mail-lb0-f181.google.com\r
+       [209.85.217.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 21DFF431FAF\r
+       for <notmuch@notmuchmail.org>; Sun, 16 Dec 2012 14:05:20 -0800 (PST)\r
+Received: by mail-lb0-f181.google.com with SMTP id ge1so4072116lbb.26\r
+       for <notmuch@notmuchmail.org>; Sun, 16 Dec 2012 14:05:19 -0800 (PST)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=google.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references\r
+       :in-reply-to:references:x-gm-message-state;\r
+       bh=e2schtg4rz8+bYNk2/qnCINuWEl+Vywl0YtcXlyDVBM=;\r
+       b=KDK2eJ6h9jCnZD9OKfvRwYRnMx8bUCb6OsTsmjvIoQ+KPZbuHd7RbXzOCGcn3z34cT\r
+       EEj9RjSehYUij2r+YyG5y0doAR3N3l9+MdCK3EEX6ABaqzu7Us/+gNHbxu8dLAYC4xUO\r
+       rhLp/z4y5n2W0kuBf9kBsKoMz4+2xsSj4kHVcxJ8ml4VL6seUJsvo1ILUySduMdnbirH\r
+       dUP/cK+vXqE4C+bKwGB/eKVESvfFoYMnp3kSd8xPZahVLIJmoS69ktn51pU4HNo+PqXY\r
+       5yThspOJ75fivgH8WU0ASpCfeK1EBmZ5JS9Blj1TaZgYSVaQUwd8Xsbp5DdrHU9ZYW+1\r
+       lcvA==\r
+Received: by 10.112.54.6 with SMTP id f6mr5090424lbp.71.1355695519618;\r
+       Sun, 16 Dec 2012 14:05:19 -0800 (PST)\r
+Received: from localhost (dsl-hkibrasgw4-50df51-27.dhcp.inet.fi.\r
+       [80.223.81.27])\r
+       by mx.google.com with ESMTPS id ml1sm4111910lab.15.2012.12.16.14.05.17\r
+       (version=SSLv3 cipher=OTHER); Sun, 16 Dec 2012 14:05:18 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v4 1/5] sprinter: clarify separator documentation\r
+Date: Mon, 17 Dec 2012 00:05:09 +0200\r
+Message-Id:\r
+ <7a846b6eaf0f7bc6a479b740d1678a6dac2b7323.1355695036.git.jani@nikula.org>\r
+X-Mailer: git-send-email 1.7.10.4\r
+In-Reply-To: <cover.1355695036.git.jani@nikula.org>\r
+References: <cover.1355695036.git.jani@nikula.org>\r
+In-Reply-To: <cover.1355695036.git.jani@nikula.org>\r
+References: <cover.1355695036.git.jani@nikula.org>\r
+X-Gm-Message-State:\r
+ ALoCoQm5uH0/Iu9X5UBr0eEZ9HmzEtuuaC07UCwfBx7kCg11KZD39tb/zNEU0cnBeMqQazyAXZYq\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 16 Dec 2012 22:05:22 -0000\r
+\r
+For text printers, the separator is a syntactic element.\r
+---\r
+ sprinter.h |    9 +++++----\r
+ 1 file changed, 5 insertions(+), 4 deletions(-)\r
+\r
+diff --git a/sprinter.h b/sprinter.h\r
+index 59776a9..f43a844 100644\r
+--- a/sprinter.h\r
++++ b/sprinter.h\r
+@@ -42,10 +42,11 @@ typedef struct sprinter {\r
+      */\r
+     void (*map_key) (struct sprinter *, const char *);\r
+ \r
+-    /* Insert a separator (usually extra whitespace) for improved\r
+-     * readability without affecting the abstract syntax of the\r
+-     * structure being printed.\r
+-     * For JSON, this could simply be a line break.\r
++    /* Insert a separator (usually extra whitespace). For the text\r
++     * printers, this is a syntactic separator. For the structured\r
++     * printers, this is for improved readability without affecting\r
++     * the abstract syntax of the structure being printed. For JSON,\r
++     * this could simply be a line break.\r
+      */\r
+     void (*separator) (struct sprinter *);\r
+ \r
+-- \r
+1.7.10.4\r
+\r