[PATCH] doc: document notmuch-dump header line

diff --git a/6b/84e1c4ab777c038397279d3e2ddcfb2021203d b/6b/84e1c4ab777c038397279d3e2ddcfb2021203d
new file mode 100644 (file)
index 0000000..967a4ba
--- /dev/null
+++ b/6b/84e1c4ab777c038397279d3e2ddcfb2021203d
@@ -0,0 +1,77 @@
+Return-Path: <bremner@tethera.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 12A506DE01F7\r
+ for <notmuch@notmuchmail.org>; Sun,  5 Jun 2016 03:24:41 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.012\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.012 tagged_above=-999 required=5\r
+ tests=[AWL=-0.001, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01]\r
+ autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id t8Uc8eFP3gBb for <notmuch@notmuchmail.org>;\r
+ Sun,  5 Jun 2016 03:24:33 -0700 (PDT)\r
+Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197])\r
+ by arlo.cworth.org (Postfix) with ESMTPS id 1FACB6DE01D0\r
+ for <notmuch@notmuchmail.org>; Sun,  5 Jun 2016 03:24:33 -0700 (PDT)\r
+Received: from remotemail by fethera.tethera.net with local (Exim 4.84)\r
+ (envelope-from <bremner@tethera.net>)\r
+ id 1b9VE9-0004NT-CS; Sun, 05 Jun 2016 06:24:17 -0400\r
+Received: (nullmailer pid 4988 invoked by uid 1000);\r
+ Sun, 05 Jun 2016 10:24:25 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: Daniel Kahn Gillmor <dkg@fifthhorseman.net>,\r
+ David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: [PATCH] doc: document notmuch-dump header line\r
+Date: Sun,  5 Jun 2016 07:24:18 -0300\r
+Message-Id: <1465122258-4940-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 2.8.1\r
+In-Reply-To: <87y46mpcbf.fsf@alice.fifthhorseman.net>\r
+References: <87y46mpcbf.fsf@alice.fifthhorseman.net>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://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: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 05 Jun 2016 10:24:41 -0000\r
+\r
+This was introduced with the libconfig changes, but not documented then.\r
+---\r
+ doc/man1/notmuch-dump.rst | 10 +++++++++-\r
+ 1 file changed, 9 insertions(+), 1 deletion(-)\r
+\r
+diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst\r
+index eda9e07..ecbeafe 100644\r
+--- a/doc/man1/notmuch-dump.rst\r
++++ b/doc/man1/notmuch-dump.rst\r
+@@ -86,7 +86,15 @@ Supported options for **dump** include\r
+       Output per-message metadata, namely tags. See *format* above\r
+       for description of the output.\r
+ \r
+-      The default is to include both tags and configuration information\r
++      The default is to include both tags and configuration\r
++      information. As of version 2 of the dump format, there is a\r
++      header line of the following form\r
++|\r
++\r
++        #notmuch-dump <*format*>:<*version*> <*included*>\r
++\r
++      where <*included*> is a comma separated list of the above\r
++      options.\r
+ \r
+     ``--output=``\ <filename>\r
+         Write output to given file instead of stdout.\r
+-- \r
+2.8.1\r
+\r