From e2fc573d42d64c063423c9808d9c10f9c05ebe81 Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Thu, 22 Sep 2011 21:00:52 +0300 Subject: [PATCH] * src/, man/, NEWS: rename --descending into --reverse --- NEWS | 36 ++++++++++++++++++-------------- man/mu-find.1 | 53 ++++++++++++++++++++++++----------------------- src/mu-cmd-find.c | 2 +- src/mu-config.c | 10 +++------ src/mu-config.h | 2 +- src/mu-query.cc | 5 ++--- src/mu-query.h | 4 ++-- 7 files changed, 56 insertions(+), 56 deletions(-) diff --git a/NEWS b/NEWS index c8f1924c..aebe0f2b 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,9 @@ * NEWS (user visible changes) +** Release 0.9.8 <> + + - '--descending' has been renamed into '--reverse' + * Release 0.9.7 <> - don't enforce UTF-8 output, use locale (fixes issue #11) @@ -10,14 +14,14 @@ - search X-Label: tags (fixes issue #40) - added toys/muile, the mu guile shells, which allows for message stats etc. - fix date handling (timezones) - + ** Release 0.9.6 <2011-05-28 Sat> - - - FreeBSD build fix + + - FreeBSD build fix - fix matching for mu cfind to be as expected - fix mu-contacts for broken names/emails - clear the contacts-cache too when doing a --rebuild - - wildcard searches ('*') for fields (except for path/maildir) + - wildcard searches ('*') for fields (except for path/maildir) - search for attachment file names (with 'a:'/'attach:') -- also works with wildcards - remove --xquery completely; use --output=xquery instead @@ -28,7 +32,7 @@ extract). Disabled by default, use --color to enable, or set env MU_COLORS to non-empty - update documentation, added more examples - + ** Release 0.9.5 <2011-04-25 Mon> - bug fix for infinite loop in Maildir detection @@ -37,19 +41,19 @@ ** Release 0.9.4 <2011-04-12 Tue> - add the 'cfind' command, to search/export contact information - - add 'flag:unread' as a synonym for 'flag:new OR NOT flag:unseen' + - add 'flag:unread' as a synonym for 'flag:new OR NOT flag:unseen' - updated documentation ** Release 0.9.3 <2011-02-13 Sun> - + - don't warn about missing files with --quiet - + ** Release 0.9.2 <2011-02-02 Wed> - stricter checking of options; and options must now *follow* the sub-command (if any); so, something like: 'mu index --maildir=/foo/bar' - - output searches as plain text (default), XML, JSON or s-expressions using + - output searches as plain text (default), XML, JSON or s-expressions using --format=plain|xml|json|sexp. For example: 'mu find foobar --output=json'. These format options are experimental (except for 'plain') - the --xquery option should now be used as --format=xquery, for output @@ -65,13 +69,13 @@ - better support for Solaris builds, Gentoo. ** Release 0.9.1 <2010-12-05 Sun> - - - Add missing icon for mug + + - Add missing icon for mug - Fix unit tests (Issue #30) - Fix Fedora 14 build (broken GTK+ 3) (Issue #31) - + ** Release 0.9 <2010-12-04 Sat> - + - you can now search for the message priority ('prio:high', 'prio:low', 'prio:normal') - you can now search for message flags, e.g. 'flag:attach' for messages with @@ -92,7 +96,7 @@ - experimental support for Fedora 14, which uses GMime 2.5.x (fixes issue #29) ** Release 0.8 <2010-10-30 Sat> - + - There's now 'mu extract' for getting information about MIME-parts (attachments) and extracting them - Queries are now internally converted to lowercase; this solves some of the @@ -104,7 +108,7 @@ - Setting the mu home dir now goes with -m, --muhome - --log-stderr, --reindex, --rebuild, --autoupgrade, --nocleanup, --mode, --linksdir, --clearlinks lost their single char version - + ** Release 0.7 <2010-02-27 Sat> - Database format changed @@ -124,7 +128,7 @@ - A test suite with a growing number of unit tests -** Release 0.6 <2010-01-23 Sat> +** Release 0.6 <2010-01-23 Sat> - First new release of mu since 2008 - No longer depends on sqlite diff --git a/man/mu-find.1 b/man/mu-find.1 index e5ac5955..f84932e3 100644 --- a/man/mu-find.1 +++ b/man/mu-find.1 @@ -1,6 +1,6 @@ .TH MU FIND 1 "July 2011" "User Manuals" -.SH NAME +.SH NAME mu find \- find e-mail messages in the \fBmu\fR database. @@ -75,11 +75,11 @@ and get mails about computers, comments, compilation and so on. Note, when running from the command-line it's import to put the query in quotes, otherwise the shell would interpret the '*'. It is important to remember that the '*' invokes the wildcard search only when used as the rightmost character -of a search term. Furthermore, it is \fBnot\fR a regular expression. +of a search term. Furthermore, it is \fBnot\fR a regular expression. In older versions of mu, queries were logged in \fI/mu.log\fR; however, since version 0.9, mu no longer does this. - + The basic way to search a message is to type some words matching it, as you would do in an internet search engine. For example, @@ -116,14 +116,14 @@ search fields and their abbreviations: from,f Message sender subject,s Message subject to,t To: recipient(s) - maildir,m Maildir + maildir,m Maildir msgid,i Message-ID prio,p Message priority ('low', 'normal' or 'high') flag,g Message Flags date,d Date-Range size,z Message size attach,a Attachment filename - tag,x Tag for the message (contents of the \fIX-Label\fR field) + tag,x Tag for the message (contents of the \fIX-Label\fR field) .fi For clarity, this man-page uses the longer versions. @@ -176,10 +176,10 @@ Note the starting '/'. If you want to match mails in the 'root' maildir, you can do with a single '/': .nf - $ mu find maildir:/ + $ mu find maildir:/ .fi -(and of course you can use the \fBm:\fR shortcut instead of \fBmaildir:\fR) +(and of course you can use the \fBm:\fR shortcut instead of \fBmaildir:\fR) The \fBdate:\fR (or \fBd:\fR) search parameter is 'special' in the fact that it takes a range of dates. For now, these dates are in ISO 8601 format @@ -194,21 +194,21 @@ To get all messages between (inclusive) the 5th of May 2009 and the 2nd of June 2010, you could use: .nf - $ mu find date:20090505..20100602 + $ mu find date:20090505..20100602 .fi Non-numeric characters are ignored, so the following is equivalent but more readable: .nf - $ mu find date:2009-05-05..2010-06-02 + $ mu find date:2009-05-05..2010-06-02 .fi Precision is up to the minute and 24-hour notation for times is used, so another example would be: .nf - $ mu find date:2009-05-05/12:23..2010-06-02/17:18 + $ mu find date:2009-05-05/12:23..2010-06-02/17:18 .fi An important point here is that the date matches are against local the local @@ -230,7 +230,7 @@ Using this notation, you can for example match messages between two and three weeks old: .nf - $ mu find date:3w..2w + $ mu find date:3w..2w .fi There are some special keywords for dates, namely 'now', meaning the @@ -238,7 +238,7 @@ prsent moment and 'today' for the beginning of today. So to get all messages sent or received today, you could use: .nf - $ mu find date:today..now + $ mu find date:today..now .fi The \fBsize\fR or \fBz\fR allows you to match \fIsize ranges\fR -- that is, @@ -265,7 +265,7 @@ and not here, as they apply to multiple mu-commands. The \fBfind\fR-command has various options that influence the way \fBmu\fR displays the results. If you don't specify anything, the defaults are -\fI\-\-fields="d f s"\fR, \fI\-\-sortfield=date\fR and \fI\-\-descending\fR. +\fI\-\-fields="d f s"\fR, \fI\-\-sortfield=date\fR and \fI\-\-reverse\fR. .TP \fB\-f\fR, \fB\-\-fields\fR=\fI\fR @@ -293,8 +293,8 @@ search parameters; the complete list: d Sent \fBd\fRate of the message f Message sender (\fBf\fRrom:) g Message flags (fla\fBg\fRs) - l Full path to the message (\fBl\fRocation) - p Message \fBp\fRriority (high, normal, low) + l Full path to the message (\fBl\fRocation) + p Message \fBp\fRriority (high, normal, low) s Message \fBs\fRubject i Message-\fBi\fRd m \fBm\fRaildir @@ -307,8 +307,9 @@ have 'asz' as its corresponding output string, while an encrypted new message would have 'nx'. .TP -\fB\-s\fR, \fB\-\-sortfield\fR \fR=\fI\fR and \fB\-z\fR, \fB\-\-descending\fR -specifies the field to sort the search results by, and the direction. The +\fB\-s\fR, \fB\-\-sortfield\fR \fR=\fI\fR and \fB\-z\fR, +\fB\-\-reverse\fR specifies the field to sort the search results by, and the +direction (i.e., 'reverse' means that the sort should be reverted - Z-A). The following fields are supported: .nf @@ -326,11 +327,11 @@ following fields are supported: Thus, for example, to sort messages by date, you could specify: .nf - $ mu find fahrrad --fields "d f s" --sortfield=date --descending + $ mu find fahrrad --fields "d f s" --sortfield=date --reverse .fi -Note, if you specify a sortfield, by default, messages are sorted in -descending order (e.g., from lowest to highest). This is usually a good +Note, if you specify a sortfield, by default, messages are sorted in reverse +(descending) order (e.g., from lowest to highest). This is usually a good choice, but for dates it may be more useful to sort in the opposite direction. .TP @@ -362,7 +363,7 @@ programming environments. \fBxquery\fR shows the Xapian query corresponding to your search terms. This is meant for for debugging purposes. - + .TP \fB\-\-linksdir\fR \fR=\fI\fR and \fB\-c\fR, \fB\-\-clearlinks\fR output the results as a maildir with symbolic links to the found @@ -423,7 +424,7 @@ information about the message, as in the following table: Here, the an 'orphan' is a message without a parent message (in the list of matches), and a duplicate is a message whose message-id was already seen -before. +before. The algorithm used for determining the threads is based on Jamie Zawinksy's description: @@ -544,7 +545,7 @@ reason, the below can be an alternative. mu-wl-search-folder)) (cmdline (concat mu-wl-mu-program " find " "--clearlinks --format=links --linksdir='" sfldr "' " - muexpr)) + muexpr)) (rv (shell-command cmdline))) (cond ((= rv 0) (message "Query succeeded")) @@ -563,10 +564,10 @@ reason, the below can be an alternative. ;; querying both in summary and folder (define-key wl-summary-mode-map (kbd "Q") ;; => query - '(lambda()(interactive)(mu-wl-search-and-goto))) + '(lambda()(interactive)(mu-wl-search-and-goto))) (define-key wl-folder-mode-map (kbd "Q") ;; => query - '(lambda()(interactive)(mu-wl-search-and-goto))) - + '(lambda()(interactive)(mu-wl-search-and-goto))) + .fi diff --git a/src/mu-cmd-find.c b/src/mu-cmd-find.c index 306b4d29..6b8f2aa5 100644 --- a/src/mu-cmd-find.c +++ b/src/mu-cmd-find.c @@ -129,7 +129,7 @@ run_query (MuQuery *xapian, const gchar *query, MuConfig *opts, } iter = mu_query_run (xapian, query, opts->threads, sortid, - opts->descending ? FALSE : TRUE, err); + opts->reverse, err); return iter; } diff --git a/src/mu-config.c b/src/mu-config.c index f15facd8..0a36346b 100644 --- a/src/mu-config.c +++ b/src/mu-config.c @@ -166,12 +166,8 @@ set_group_find_defaults (MuConfig *opts) * *are* specified, we sort in ascending order. */ if (!opts->fields) { opts->fields = "d f s"; - if (!opts->sortfield) { + if (!opts->sortfield) opts->sortfield = "d"; - opts->descending = TRUE; - } else - opts->descending = FALSE; - } if (!opts->formatstr) /* by default, use plain output */ @@ -203,8 +199,8 @@ config_options_group_find (MuConfig *opts) "show message threads", NULL}, {"bookmark", 'b', 0, G_OPTION_ARG_STRING, &opts->bookmark, "use a bookmarked query", NULL}, - {"descending", 'z', 0, G_OPTION_ARG_NONE, &opts->descending, - "sort in descending order (z -> a)", NULL}, + {"reverse", 'z', 0, G_OPTION_ARG_NONE, &opts->reverse, + "sort in reverse (descending) order (z -> a)", NULL}, {"summary", 'k', 0, G_OPTION_ARG_NONE, &opts->summary, "include a short summary of the message (false)", NULL}, {"linksdir", 0, 0, G_OPTION_ARG_STRING, &opts->linksdir, diff --git a/src/mu-config.h b/src/mu-config.h index 4c9e82af..f7319a26 100644 --- a/src/mu-config.h +++ b/src/mu-config.h @@ -111,7 +111,7 @@ struct _MuConfig { /* options for querying 'find' (and view-> 'summary') */ char *fields; /* fields to show in output */ char *sortfield; /* field to sort by (string) */ - gboolean descending; /* sort descending (z->a)? */ + gboolean reverse; /* sort in revers order (z->a) */ gboolean threads; /* show message threads */ gboolean summary; /* include a summary? */ char *bookmark; /* use bookmark */ diff --git a/src/mu-query.cc b/src/mu-query.cc index 9fed2dcf..ad4a8e30 100644 --- a/src/mu-query.cc +++ b/src/mu-query.cc @@ -296,7 +296,7 @@ mu_query_preprocess (const char *query) MuMsgIter* mu_query_run (MuQuery *self, const char* searchexpr, gboolean threads, - MuMsgFieldId sortfieldid, gboolean ascending, + MuMsgFieldId sortfieldid, gboolean reverse, GError **err) { g_return_val_if_fail (self, NULL); @@ -311,8 +311,7 @@ mu_query_run (MuQuery *self, const char* searchexpr, gboolean threads, * there, and don't let Xapian do any sorting */ if (!threads && sortfieldid != MU_MSG_FIELD_ID_NONE) enq.set_sort_by_value ((Xapian::valueno)sortfieldid, - ascending ? true : false); - + reverse ? true : false); if (!mu_str_is_empty(searchexpr)) /* NULL or "" */ enq.set_query(get_query (self, searchexpr, err)); else diff --git a/src/mu-query.h b/src/mu-query.h index 41e41d84..d07f80a3 100644 --- a/src/mu-query.h +++ b/src/mu-query.h @@ -73,8 +73,8 @@ char* mu_query_version (MuQuery *store) * @param threads calculate message-threads * @param sortfield the field id to sort by or MU_MSG_FIELD_ID_NONE if * sorting is not desired - * @param ascending if TRUE sort in ascending (A-Z) order, otherwise, - * sort in descending (Z-A) order + * @param reverse if TRUE, sort in descending (Z-A) order, otherwise, + * sort in descending (A-Z) order * @param err receives error information (if there is any); if * function returns non-NULL, err will _not_be set. err can be NULL * possible error (err->code) is MU_ERROR_QUERY,