]> git.cworth.org Git - notmuch-wiki/blobdiff - news/release-0.6.mdwn
news markup tunes
[notmuch-wiki] / news / release-0.6.mdwn
index e19561f05380e1b8f37e927526d4fa82091c414b..2d16c5bb47a684c079f9c33f667d57aa82e48ef2 100644 (file)
@@ -2,21 +2,23 @@
 
 Notmuch 0.6 (2011-07-01)
 =======================
+
 New, general features
 ---------------------
-Folder-based searching
+
+* **_Folder-based searching_**
 
   Notmuch queries can now include a search term to match the
   directories in which mail files are stored (within the mail
   storage). The syntax is as follows:
 
-       folder:<path>
+           folder:<path>
 
   For example, one might use things such as:
 
-       folder:spam
-       folder:2011-*
-       folder:work/todo
+           folder:spam
+           folder:2011-*
+           folder:work/todo
 
   to match any path containing a directory "spam", "work/todo", or
   containing a directory starting with "2011-", respectively.
@@ -31,18 +33,18 @@ Folder-based searching
   this feature for all mail, the entire notmuch index will need to be
   rebuilt as follows:
 
-       notmuch dump > notmuch.dump
-       # Backup, then remove notmuch database ($MAIL/.notmuch)
-       notmuch new
-       notmuch restore notmuch.dump
+           notmuch dump > notmuch.dump
+           # Backup, then remove notmuch database ($MAIL/.notmuch)
+           notmuch new
+           notmuch restore notmuch.dump
 
-Support for PGP/MIME
+* **_Support for PGP/MIME_**
 
-  Both the command line interface and the emacs-interface have new
+  Both the command-line interface and the emacs-interface have new
   support for PGP/MIME, detailed below. Thanks to Daniel Kahn Gillmor
   and Jameson Graef Rollins for making this happen.
 
-New, automatic tags: "signed" and "encrypted"
+* **_New, automatic tags: "signed" and "encrypted"_**
 
   These tags will automatically be applied to messages containing
   multipart/signed and multipart/encrypted parts.
@@ -52,25 +54,26 @@ New, automatic tags: "signed" and "encrypted"
 
 New command-line features
 -------------------------
-Add new "notmuch show --verify" option for signature verification
+
+* **_Add new "notmuch show --verify" option for signature verification_**
 
   This option instruct notmuch to verify the signature of
   PGP/MIME-signed parts.
 
-Add new "notmuch show --decrypt" and "notmuch reply --decrypt" options
+* **_Add new "notmuch show --decrypt" and "notmuch reply --decrypt" options_**
 
   This option instructs notmuch to decrypt PGP/MIME-encrypted parts.
   Note that this feature currently requires gpg-agent and a passphrase entry
   tool (e.g. pinentry-gtk or pinentry-curses).
 
-Proper nesting of multipart parts in "notmuch show" output
+* **_Proper nesting of multipart parts in "notmuch show" output_**
 
   MIME parts are now display with proper nesting to reflect original
   MIME hierarchy of a message. This allows clients to correctly
   analyze the MIME structure, (such as, for example, determining to
   which parts a signature part applies).
 
-Add new "notmuch show --part" option
+* **_Add new "notmuch show --part" option_**
 
   This is a replacement for the older "notmuch part" command, (which
   is now deprecated—it should still work as always, but is no longer
@@ -79,7 +82,7 @@ Add new "notmuch show --part" option
   part, (such as --format=json for extracting a message part with JSON
   formatting).
 
-Deprecate "notmuch search-tags", (in favor of "notmuch search --output=tags *")
+* **_Deprecate "notmuch search-tags" (in favor of "notmuch search --output=tags *")_**
 
   The "notmuch search-tags" sub-command has been redundant since the
   addition of the --output=tags option to "notmuch search". We now
@@ -89,7 +92,8 @@ Deprecate "notmuch search-tags", (in favor of "notmuch search --output=tags *")
 
 Performance improvements
 ------------------------
-Faster searches (by doing fewer searches to construct threads)
+
+* **_Faster searches (by doing fewer searches to construct threads)_**
 
   Whenever a user asks for search results as threads, notmuch first
   performs a search for messages matching the query, then performs
@@ -98,7 +102,7 @@ Faster searches (by doing fewer searches to construct threads)
   Removing inefficiencies and redundancies in these secondary searches
   results in a measured speedups of 1.5x for a typical search.
 
-Faster searches (by doing fewer passes to gather message data)
+* **_Faster searches (by doing fewer passes to gather message data)_**
 
   Optimizing Xapian data access patterns (using a single pass to get
   all message-document data rather than a pass for each data type)
@@ -109,13 +113,13 @@ Faster searches (by doing fewer passes to gather message data)
   of 2.5x for a search of all messages in his inbox (was 4.5s, now
   1.8s). Thanks, Austin!
 
-Faster initial indexing
+* **_Faster initial indexing_**
 
   More efficient indexing of new messages results in a measured
   speedup of 1.4x for the initial indexing of 3 GB of mail (1h 14m
   rather than 1h 46m). Thanks to Austin Clements and Michal Sojka.
 
-Make "notmuch new" faster for unchanged directories
+* **_Make "notmuch new" faster for unchanged directories_**
 
   Optimizing to not do any further examinations of sub-directories
   when the filesystem indicates that a directory is unchanged from the
@@ -125,23 +129,23 @@ Make "notmuch new" faster for unchanged directories
 New emacs-interface features
 ----------------------------
 
-Support for PGP/MIME (GnuPG)
+* **_Support for PGP/MIME (GnuPG)_**
 
   Automatically indicate validity of signatures for multipart/signed
   messages.  Automatically display decrypted content for
   multipart/encrypted messages.  See the emacs variable
   notmuch-crypto-process-mime for more information. Note that this
-  needs gpg-agent and a pinentry tool just as the command line tools.
+  needs gpg-agent and a pinentry tool just as the command-line tools.
   Also note there is no support SMIME yet.
 
-Output of pipe command is now displayed if pipe command fails
+* **_Output of pipe command is now displayed if pipe command fails_**
 
   This is extremely useful in the common use case of piping a patch to
   "git am". If git fails to cleanly merge the patch the error messages
   from the failed merge are now clearly displayed to the user, (where
   previously they were silently hidden from the user).
 
-User-selectable From address
+* **_User-selectable From address_**
 
   A user can choose which configured email addresses should be used as
   the From address whenever composing a new message. To do so, simply
@@ -157,23 +161,24 @@ User-selectable From address
   the "Notmuch Always Prompt For Sender" option in the notmuch
   customize group.
 
-Hiding of repeated subjects in collapsed thread view
+* **_Hiding of repeated subjects in collapsed thread view_**
 
   In notmuch-show mode, if a collapsed message has the same subject as
   its parent, the subject is not shown.
 
-Automatic detection and hiding of original message in top-posted message
+* **_Automatic detection and hiding of original message in top-posted 
+  message_**
 
   When a message contains a line looking something like:
 
-       ----- Original Message -----
+           ----- Original Message -----
 
   emacs hides this and all subsequent lines as an "original message",
   (allowing the user to click or press enter on the "original message"
   button to display it again). This makes the handling of top-posted
   citations work much like conventional citations.
 
-New hooks for running code when tags are modified
+* **_New hooks for running code when tags are modified_**
 
   Some users want to perform additional actions whenever a particular
   tag is added/removed from a message. This could be used to, for
@@ -181,16 +186,16 @@ New hooks for running code when tags are modified
   tool. To facilitate this, two new hooks are added which can be
   modified in the following settings of the notmuch customize group:
 
-       Notmuch Before Tag Hook
-       Notmuch After Tag Hook
+           Notmuch Before Tag Hook
+           Notmuch After Tag Hook
 
-New optional support for hiding some multipart/alternative parts
+* **_New optional support for hiding some multipart/alternative parts_**
 
   Many emails are sent with redundant content within a
   multipart/alternative group (such as a text/plain part as well as a
   text/html part). Users can configure the setting:
 
-       Notmuch Show All Multipart/Alternative Parts
+           Notmuch Show All Multipart/Alternative Parts
 
   to "off" in the notmuch customize group to have the interface
   automatically hide some part alternatives (such as text/html
@@ -198,12 +203,13 @@ New optional support for hiding some multipart/alternative parts
   because there's not yet a simple way to re-display such a hidden
   part if it is not actually redundant with a displayed part.
 
-Better rendering of text/x-vcalendar parts
+* **_Better rendering of text/x-vcalendar parts_**
 
   These parts are now displayed in a format suitable for use with the
   emacs diary.
 
-Avoid getting confused by Subject and Author fields with newline characters
+* **_Avoid getting confused by Subject and Author fields with newline
+  characters_**
 
   Replacing all characters with ASCII code less than 32 with a question mark.
 
@@ -212,6 +218,7 @@ and drop "name" if it's actually just a repeat of the email address).
 
 Vim interface improvements
 --------------------------
+
 Felipe Contreras provided a number of updates for the vim interface:
 
   * Using sendmail directly rather than mailx,
@@ -222,49 +229,53 @@ Felipe Contreras provided a number of updates for the vim interface:
 
 Bindings improvements
 ---------------------
-Ruby bindings are now much more complete
 
-  Including QUERY.sort, QUERY.to\_s, MESSAGE.maildir\_flags\_to\_tags,
-  MESSAGE.tags\_to\_maildir\_flags, and MESSAGE.get\_filenames
+* **_Ruby bindings are now much more complete_**
+
+  Including `QUERY.sort`, `QUERY.to_s`, `MESSAGE.maildir_flags_to_tags`,
+  `MESSAGE.tags_to_maildir_flags`, and `MESSAGE.get_filenames`
+
+* **_Python bindings have been updated and extended_**
 
-* Python bindings have been updated and extended
   (docs online at http://packages.python.org/notmuch/)
 
   New bindings:
-  - Message().get\_filenames(),
-  - Message().tags\_to\_maildir\_flags(),Message().maildir\_flags\_to\_tags()
-  - list(Threads()) and list(Messages) works now
+  - `Message().get_filenames()`,
+  - `Message().tags_to_maildir_flags()`, `Message().maildir_flags_to_tags()`
+  - `list(Threads())` and `list(Messages)` works now
 
-  - Message().\_\_cmp\_\_() and \_\_hash\_\_()
-  These allow, for example:
-       if msg1 == msg2: ...
+  - `Message().__cmp__() and __hash__()`
+        These allow, for example:
+           if msg1 == msg2: ...
 
-  As well as set arithmetic on Messages():
+  As well as set arithmetic on `Messages()`:
 
-       s1, s2= set(msgs1), set(msgs2)
-       s1.union(s2)
-       s2 -= s1
+           s1, s2= set(msgs1), set(msgs2)
+           s1.union(s2)
+           s2 -= s1
 
   Removed:
-     - len(Messages()) as it exhausted the iterator.
-       Use len(list(Messages())) or
-       Query.count_messages() to get the length.
+  - len(Messages()) as it exhausted the iterator.
+        Use len(list(Messages())) or
+        `Query.count_messages()` to get the length.
 
-Added initial Go bindings in bindings/go
+* **_Added initial Go bindings in bindings/go_**
 
 New build-system features
 -------------------------
-Added support for building in a directory other than the source directory
+
+* **_Added support for building in a directory other than the source
+  directory_**
 
   This can be used with the widely-supported idiom of simply running
   the configure script from some other directory:
 
-       mkdir build
-       cd build
-       ../configure
-       make
+           mkdir build
+           cd build
+           ../configure
+           make
 
-Fix to save configure options for future, implicit runs of configure
+* **_Fix to save configure options for future, implicit runs of configure_**
 
   When a user updates the source (such as with "git pull") calling
   "make" may cause an automatic re-run of the configure script. When
@@ -274,7 +285,8 @@ Fix to save configure options for future, implicit runs of configure
 
 New test-suite feature
 ----------------------
-Binary for bash for running test suite now located via PATH.
+
+* **_Binary for bash for running test suite now located via PATH_**
 
   The notmuch test suite requires a fairly recent version of bash (>=
   bash 4). As some systems supply an older version of bash at
@@ -283,16 +295,16 @@ Binary for bash for running test suite now located via PATH.
   simply install bash >= 4 somewhere on $PATH before /bin and then use
   the test suite.
 
-Support for testing output with a trailing newline.
+* **_Support for testing output with a trailing newline_**
 
   Previously, some tests would fail to notice a difference in the
   presence/absence of a trailing newline in a program output, (which
   has led to bugs in the past). Now, carefully-written tests (using
-  test\_expect\_equal\_file rather than test\_expect\_equal) will detect
+  `test_expect_equal_file` rather than `test_expect_equal`) will detect
   any change in the presence/absence of a trailing newline. Many tests
   are updated to take advantage of this.
 
-Avoiding accessing user's $HOME while running test suite
+* **_Avoiding accessing user's $HOME while running test suite_**
 
   The test suite now carefully creates its own HOME directory. This
   allows the test suite to be run with no existing HOME directory, (as
@@ -302,40 +314,41 @@ Avoiding accessing user's $HOME while running test suite
 
 General bug fixes
 -----------------
-Output *all* files for "notmuch search --output=files"
+
+* **_Output *all* files for "notmuch search --output=files"_**
 
   For the cases where multiple files have the same Message ID,
   previous versions of notmuch would output only one such file. This
   command is now fixed to correctly output all files.
 
-Fixed spurious search results from "overlapped" indexing of addresses
+* **_Fixed spurious search results from "overlapped" indexing of addresses_**
 
   This fixed a bug where a search for:
 
-       to:user@elsewhere.com
+           to:user@elsewhere.com
 
   would incorrectly match a message sent:
 
-       To: user@example,com, someone@elsewhere.com
+           To: user@example,com, someone@elsewhere.com
 
-Fix --output=json when search has no results
+* **_Fix --output=json when search has no results_**
 
   A bug present since notmuch 0.4 had caused searches with no results
   to produce an invalid json object. This is now fixed to cleanly
   return a valid json object representing an empty array "[]" as
   expected.
 
-fix the automatic detection of the From address for "notmuch reply"
-from the Received headers in some cases.
+* **_Fix the automatic detection of the From address for "notmuch reply"
+  from the Received headers in some cases._**
 
-Fix core dump on DragonFlyBSD due to -1 return value from
-sysconf(\_SC\_GETPW\_R\_SIZE\_MAX).
+* **_Fix core dump on DragonFlyBSD due to -1 return value from
+  `sysconf(_SC_GETPW_R_SIZE_MAX)`._**
 
-Cleaned up several memory leaks
+* **_Cleaned up several memory leaks_**
 
-Eliminated a few, rare segmentation faults and a double-free.
+* **_Eliminated a few, rare segmentation faults and a double-free_**
 
-Fix libnotmuch library to only export notmuch API functions
+* **_Fix libnotmuch library to only export notmuch API functions_**
 
   Previous release of the notmuch library also exported some Xapian
   C++ exception type symbols. These were never part of the library
@@ -343,27 +356,29 @@ Fix libnotmuch library to only export notmuch API functions
 
 Emacs-interface bug fixes
 -------------------------
-Display any unexpected output or errors from "notmuch search" invocations
+
+* **_Display any unexpected output or errors from "notmuch search"
+invocations_**
 
   Previously any misformatted output or trailing error messages were
   silently ignored. This output is now clearly displayed. This fix was
   very helpful in identifying and fixing the bug described below.
 
-Fix bug where some threads would be missing from large search results
+* **_Fix bug where some threads would be missing from large search results_**
 
   When a search returned a "large" number of results, the emacs
   interface was incorrectly dropping one thread every time the output
   of the "notmuch search" process spanned the emacs read-buffer. This
   is now fixed.
 
-Avoid re-compression of .gz files (and similar) when saving attachment
+* **_Avoid re-compression of .gz files (and similar) when saving attachment_**
 
   Emacs was being too clever for its own good and trying to
   re-compress pre-compressed .gz files when saving such attachments
   (potentially corrupting the attachment). The emacs interface is
   fixed to avoid this bug.
 
-Fix hiding of a message when a previously-hidden citation is visible
+* **_Fix hiding of a message when a previously-hidden citation is visible_**
 
   Previously the citation would remain visible in this case. This is
   fixed so that hiding a message hides all parts.