CHANGELOG: Document this branch

And add a warning about toggling the setting for active feeds.

For both George and me, the motivation for this change was working
around feed authors that change the id after minor changes in content:

  On Sat, Jan 18, 2014 at 1:40 PM, W. Trevor King wrote:
  > Some of the newspaper feeds I follow have duplicate entries in
  > their feed if they tweaked the title or content, but I rarely care
  > about the changes.

  On Sat, Jan 18, 2014 at 02:16:19PM -0500, George Saunders wrote:
  > That's exactly the situation I added it for.

The Atom spec explicitly says that revisions should keep the same id
[1]:

  When an Atom Document is relocated, migrated, syndicated,
  republished, exported, or imported, the content of its atom:id
  element MUST NOT change.  Put another way, an atom:id element
  pertains to all instantiations of a particular Atom entry or feed;
  revisions retain the same content in their atom:id elements.

But not all feed generators are fully compliant ;).

[1]: http://tools.ietf.org/search/rfc4287#section-4.2.6

Signed-off-by: W. Trevor King <wking@tremily.us>

diff --git a/CHANGELOG b/CHANGELOG
index 03b42cb008df7bedd6436714adb3e2e87038b7f1..a866fa63f27b09d8e64ceae2af2575224e937da9 100644 (file)
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,4 +1,5 @@
 v3.8 (unreleased)
+    * Add a new `trust-link` setting, to prefer the `link` attribute over the `id` attribute for identifying entries.
     * Sluggify feed names on opmlimport.
     * Allow Unicode letters and digits in feed names, instead of just ASCII lettters and digits.
 

diff --git a/README b/README
index 2e1f0b7e3f1d7c1d25700599b025026b45cc5ee1..fcb5f4895c0aeb5d6f4937576cecc68eb68a3c55 100644 (file)
--- a/README
+++ b/README
@@ -141,7 +141,8 @@ entries converted to plain text::
   html-mail = True
 
 To be notified every time a post changes, instead of just when it's
-first posted::
+first posted (see also ``trust-link``, described in
+``rss2email/config.py``)::
 
   trust-guid = True
 

diff --git a/rss2email/config.py b/rss2email/config.py
index 1f9ebbe685705e5212f99d97f803254b77f4c30f..40c4c0f9c91fbf10d93136d124ea534c7678d8f7 100644 (file)
--- a/rss2email/config.py
+++ b/rss2email/config.py
@@ -109,6 +109,9 @@ CONFIG['DEFAULT'] = _collections.OrderedDict((
         ('trust-guid', str(True)),
         # True: Receive one email per unique link url.
         # False: Defer to trust-guid preference.
+        # Toggling this for existing feeds may result in duplicates,
+        # because the old entries will not be recorded under their new
+        # link-based ids.
         ('trust-link', str(False)),
         # To most correctly encode emails with international
         # characters, we iterate through the list below and use the