[PATCH 1/6] NEWS: cleartext indexing section includes session keys

[PATCH 1/6] NEWS: cleartext indexing section includes session keys

[Daniel Kahn Gillmor]

These are part and parcel of the same feature, so include the overview
here.
---
 NEWS | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/NEWS b/NEWS
index 10752fa7..989cc405 100644
--- a/NEWS
+++ b/NEWS
@@ -43,13 +43,22 @@ Indexing cleartext of encrypted e-mails
   It's now possible to include the cleartext of encrypted e-mails in
   the notmuch index.  This makes it possible to search your encrypted
   e-mails with the same ease as searching cleartext.  This can be done
-  on a per-message basis with the --decrypt argument to indexing
+  on a per-message basis by passing --decrypt=true to indexing
   commands (new, insert, reindex), or by default by running "notmuch
   config set index.decrypt true".
 
-  Note that the contents of the index are sufficient to roughly
-  reconstruct the cleartext of the message itself, so please ensure
-  that the notmuch index itself is adequately protected.  DO NOT USE
+  Encrypted messages whose cleartext is indexed will typically also
+  have their session keys stashed as properties associated with the
+  message.  Stashed session keys permit rapid rendering of long
+  encrypted threads, and disposal of expired encryption-capable keys.
+  If for some reason you want cleartext indexing without stashed
+  session keys, use --decrypt=nostash for your indexing commands (or
+  run "notmuch config set index.decrypt nostash"). See `index.decrypt`
+  in notmuch-config(1) for more details.
+
+  Note that stashed session keys permit reconstruction of the
+  cleartext of the encrypted message itself, and the contents of the
+  index are roughly equivalent to the cleartext as well.  DO NOT USE
   this feature without considering the security of your index.
 
 Library Changes
-- 
2.15.1

[PATCH 2/6] NEWS: transition n_d_add_message to n_d_index_file

[Daniel Kahn Gillmor]

---
 NEWS | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/NEWS b/NEWS
index 989cc405..a7ca0245 100644
--- a/NEWS
+++ b/NEWS
@@ -82,6 +82,14 @@ Change of return value of `notmuch_thread_get_authors`
   returned NULL.  This has been replaced by an empty string, since the
   possibility of NULL was not documented.
 
+Transition `notmuch_database_add_message` to `notmuch_database_index_file`
+
+   When indexing an e-mail message, the new
+   `notmuch_database_index_file` function is the preferred form, and
+   the old `notmuch_database_add_message` is deprecated.  The new form
+   allows passing a set of options to the indexing engine, which the
+   operator may decide to change from message to message.
+
 Python Bindings
 ---------------
 
-- 
2.15.1

[PATCH 3/6] NEWS: note decrypt_policy in python bindings for index_file

[Daniel Kahn Gillmor]

---
 NEWS | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/NEWS b/NEWS
index a7ca0245..274d522c 100644
--- a/NEWS
+++ b/NEWS
@@ -104,6 +104,8 @@ Open mail files in binary mode when using Python 3
 
 Add python bindings for notmuch_database_{get,set}_config*
 
+Optional `decrypt_policy` flag is available for notmuch.database().index_file()
+
 nmbug
 -----
 
-- 
2.15.1

[PATCH 4/6] NEWS: notmuch {show, reply} --decrypt takes explicit argument

[Daniel Kahn Gillmor]

---
 NEWS | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/NEWS b/NEWS
index 274d522c..997c07d3 100644
--- a/NEWS
+++ b/NEWS
@@ -35,6 +35,12 @@ Support maildir synced tags in `new.tags`
   maildir syncing, and will be added for files in `new/` regardless of
   the setting of `new.tags`.
 
+--decrypt now takes an explicit argument
+
+  The --decrypt option to `notmuch show` and `notmuch reply` now takes
+  an explicit argument.  If you were used to invoking `notmuch show
+  --decrypt`, you should switch to `notmuch show --decrypt=true`.
+
 Encrypted Mail
 --------------
 
-- 
2.15.1

[PATCH 5/6] NEWS: document notmuch_message_remove_all_properties_with_prefix

[Daniel Kahn Gillmor]

---
 NEWS | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/NEWS b/NEWS
index 997c07d3..7b50afc0 100644
--- a/NEWS
+++ b/NEWS
@@ -82,6 +82,12 @@ New functions to count files
   Two new functions in the libnotmuch API:
   `notmuch_message_count_files`, and `notmuch_thread_get_total_files`.
 
+New function to remove properties
+
+  A new function was added to the libnotmuch API to make it easier to
+  drop all properties with a common pattern:
+  `notmuch_message_remove_all_properties_with_prefix`
+
 Change of return value of `notmuch_thread_get_authors`
 
   In certain corner cases, `notmuch_thread_get_authors` previously
-- 
2.15.1

[PATCH 6/6] NEWS: document notmuch-properties(7)

[Daniel Kahn Gillmor]

---
 NEWS | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/NEWS b/NEWS
index 7b50afc0..47b62d73 100644
--- a/NEWS
+++ b/NEWS
@@ -131,6 +131,16 @@ User-facing changes with this notmuch release:
 * Only error for invalid diff lines in `tags/`, which allows for
   `README`s and similar in nmbug repositories.
 
+Documentation
+-------------
+
+New man page: notmuch-properties(7)
+
+  This new page to the manual describes common conventions for how
+  properties are used by libnotmuch, the CLI, and associated programs.
+  External projects that use properties are encouraged to claim their
+  properties and conventions here to avoid collisions.
+
 Notmuch 0.25.3 (2017-12-08)
 ===========================
 
-- 
2.15.1