Return-Path: <markwalters1009@gmail.com>
X-Original-To: notmuch@notmuchmail.org
Delivered-To: notmuch@notmuchmail.org
Received: from localhost (localhost [127.0.0.1])
	by olra.theworths.org (Postfix) with ESMTP id 0EBD4431FBC
	for <notmuch@notmuchmail.org>; Sat, 12 Apr 2014 01:51:41 -0700 (PDT)
X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
X-Spam-Flag: NO
X-Spam-Score: 2.7
X-Spam-Level: **
X-Spam-Status: No, score=2.7 tagged_above=-999 required=5
	tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,
	FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,
	FREEMAIL_REPLY=2.499, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled
Received: from olra.theworths.org ([127.0.0.1])
	by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
	with ESMTP id YJaobNMavv93 for <notmuch@notmuchmail.org>;
	Sat, 12 Apr 2014 01:51:35 -0700 (PDT)
Received: from mail-we0-f173.google.com (mail-we0-f173.google.com
	[74.125.82.173]) (using TLSv1 with cipher RC4-SHA (128/128 bits))
	(No client certificate requested)
	by olra.theworths.org (Postfix) with ESMTPS id 4C792431FAF
	for <notmuch@notmuchmail.org>; Sat, 12 Apr 2014 01:51:35 -0700 (PDT)
Received: by mail-we0-f173.google.com with SMTP id w61so6391381wes.32
	for <notmuch@notmuchmail.org>; Sat, 12 Apr 2014 01:51:31 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;
	h=from:to:cc:subject:date:message-id:in-reply-to:references;
	bh=P4WMG7ENSvaHTDEuogA91obfGs8exmWdeYVv/fn9VIc=;
	b=mXYQ2/jlfkRz7Wszm5e4ppPDkG01zhj2FGYJxyVnKkfkyZ9Z5tI3GegObxzFaXUIK/
	Rb86Yric+ZOVLFiDM5LZOTUjAfVJRj55W96Jq1ZY7arriRrrxgmhwiqePVATZhSlkulD
	zq1xe3fYRgDEWFKOjZH0YOCpFrZvVk9LlpQuPLlMGI8n3bWYMfX82zuiqPDf9nj2dQaU
	S3BAmwuxd6anATbLPdO8tXSbqKZW1bjR9dzfM3ehH4x8Gdy1Iiiu61yylauxkx7TzRr7
	3Mp0+wBV957PeJs9+W616Xy0jIEcHUg6BbvqYNWVG2RHlnyJZxcImn9+rSxer7KOaISz
	WJnA==
X-Received: by 10.194.203.170 with SMTP id kr10mr24607721wjc.19.1397292691374;
 	Sat, 12 Apr 2014 01:51:31 -0700 (PDT)
Received: from localhost (5751dfa2.skybroadband.com. [87.81.223.162])
	by mx.google.com with ESMTPSA id eq8sm9404230wib.16.2014.04.12.01.51.30
	for <multiple recipients>
	(version=TLSv1.2 cipher=RC4-SHA bits=128/128);
	Sat, 12 Apr 2014 01:51:30 -0700 (PDT)
From: Mark Walters <markwalters1009@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH] emacs: hello: update docs for saved-search sort defcustom.
Date: Sat, 12 Apr 2014 09:51:27 +0100
Message-Id: <1397292687-27681-1-git-send-email-markwalters1009@gmail.com>
X-Mailer: git-send-email 1.7.10.4
In-Reply-To: <1397292033-26502-1-git-send-email-markwalters1009@gmail.com>
References: <1397292033-26502-1-git-send-email-markwalters1009@gmail.com>
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.13
Precedence: list
List-Id: "Use and development of the notmuch mail system."
	<notmuch.notmuchmail.org>
List-Unsubscribe: <http://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: <http://notmuchmail.org/mailman/listinfo/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Sat, 12 Apr 2014 08:51:41 -0000

Update the documentation for notmuch-saved-search-sort-function to
match the new format and recommend the best way to access the fields
(which should minimize breakage if we need to change the format again
in the future).

---
This could be rolled into id:1397292033-26502-1-git-send-email-markwalters1009@gmail.com

Best wishes

Mark


 emacs/notmuch-hello.el |    6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el
index fca2bcc..b8ec665 100644
--- a/emacs/notmuch-hello.el
+++ b/emacs/notmuch-hello.el
@@ -54,8 +54,10 @@ (defcustom notmuch-saved-search-sort-function nil
 stored in `notmuch-saved-searches'. Sort alphabetically sorts the
 saved searches in alphabetical order. Custom sort function should
 be a function or a lambda expression that takes the saved
-searches alist as a parameter, and returns a new saved searches
-alist to be used."
+searches list as a parameter, and returns a new saved searches
+list to be used. For compatibility with the various saved-search
+formats it should use notmuch-saved-search-get to access the
+fields of the search."
   :type '(choice (const :tag "No sorting" nil)
 		 (const :tag "Sort alphabetically" notmuch-sort-saved-searches)
 		 (function :tag "Custom sort function"
-- 
1.7.10.4