Return-Path: <bremner@tethera.net>
X-Original-To: notmuch@notmuchmail.org
Delivered-To: notmuch@notmuchmail.org
Received: from localhost (localhost [127.0.0.1])
 by arlo.cworth.org (Postfix) with ESMTP id 3607A6DE0281
 for <notmuch@notmuchmail.org>; Sun,  5 Jun 2016 15:24:15 -0700 (PDT)
X-Virus-Scanned: Debian amavisd-new at cworth.org
X-Spam-Flag: NO
X-Spam-Score: -0.012
X-Spam-Level: 
X-Spam-Status: No, score=-0.012 tagged_above=-999 required=5
 tests=[AWL=-0.001, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01]
 autolearn=disabled
Received: from arlo.cworth.org ([127.0.0.1])
 by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)
 with ESMTP id V8C7SuPWx07b for <notmuch@notmuchmail.org>;
 Sun,  5 Jun 2016 15:24:06 -0700 (PDT)
Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197])
 by arlo.cworth.org (Postfix) with ESMTPS id B81556DE01C2
 for <notmuch@notmuchmail.org>; Sun,  5 Jun 2016 15:24:06 -0700 (PDT)
Received: from remotemail by fethera.tethera.net with local (Exim 4.84)
 (envelope-from <bremner@tethera.net>)
 id 1b9gSW-0004nP-6V; Sun, 05 Jun 2016 18:23:52 -0400
Received: (nullmailer pid 15280 invoked by uid 1000);
 Sun, 05 Jun 2016 22:24:00 -0000
From: David Bremner <david@tethera.net>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: [PATCH] doc: document notmuch-dump header line
Date: Sun,  5 Jun 2016 19:23:58 -0300
Message-Id: <1465165438-15230-1-git-send-email-david@tethera.net>
X-Mailer: git-send-email 2.8.1
In-Reply-To: <1465122258-4940-1-git-send-email-david@tethera.net>
References: <1465122258-4940-1-git-send-email-david@tethera.net>
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.20
Precedence: list
List-Id: "Use and development of the notmuch mail system."
 <notmuch.notmuchmail.org>
List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,
 <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
List-Archive: <http://notmuchmail.org/pipermail/notmuch/>
List-Post: <mailto:notmuch@notmuchmail.org>
List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,
 <mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Sun, 05 Jun 2016 22:24:15 -0000

This was introduced with the libconfig changes, but not documented then.
---

after some IRC discussion with Tomi, this rst is slightly less gross

 doc/man1/notmuch-dump.rst | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst
index eda9e07..94986a8 100644
--- a/doc/man1/notmuch-dump.rst
+++ b/doc/man1/notmuch-dump.rst
@@ -86,7 +86,15 @@ Supported options for **dump** include
 	Output per-message metadata, namely tags. See *format* above
 	for description of the output.
 
-      The default is to include both tags and configuration information
+      The default is to include both tags and configuration
+      information. As of version 2 of the dump format, there is a
+      header line of the following form
+
+      |
+      |  #notmuch-dump <*format*>:<*version*> <*included*>
+
+      where <*included*> is a comma separated list of the above
+      options.
 
     ``--output=``\ <filename>
         Write output to given file instead of stdout.
-- 
2.8.1