debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-22 02:48:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

lib: Document that absence of maildir flags can also remove/add tags

Browse source 
Previously the documentation of notmuch_message_maildir_flags_to_tags
suggested that the presence of a flag would cause tags to be added,
(or in the case of "unread", removed). But the case of absent maildir
flags was not explicitly described.

What we actually want, is that for supported flags, the absence of the
flag in all messages causes the corresponding tag to be removed,
(or in the case of "unread", added). So document that explicitly.

This is the case recently added to the test suite as a failing test,
(so we'll need to do bug fixing before the documentation is honest
here).
This commit is contained in:
Carl Worth 2010-11-11 02:45:24 -08:00
parent 0100df8edb
commit 5a98880add
1 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
lib/notmuch.h
View file

@ -915,14 +915,17 @@ notmuch_message_remove_all_tags (notmuch_message_t *message);
* flags, and adds or removes tags on 'message' as follows when these * flags, and adds or removes tags on 'message' as follows when these
* flags are present: * flags are present:
* *
* Flag Action * Flag Action if present
* ---- ------ * ---- -----------------
* 'D' Adds the "draft" tag to the message * 'D' Adds the "draft" tag to the message
* 'F' Adds the "flagged" tag to the message * 'F' Adds the "flagged" tag to the message
* 'P' Adds the "passed" tag to the message * 'P' Adds the "passed" tag to the message
* 'R' Adds the "replied" tag to the message * 'R' Adds the "replied" tag to the message
* 'S' Removes the "unread" tag from the message * 'S' Removes the "unread" tag from the message
* *
* For each flag that is not present, the opposite action (add/remove)
* is performed for the corresponding tags.
*
* The only filenames examined for flags are filenames which appear to * The only filenames examined for flags are filenames which appear to
* be within a maildir directory, (the file must be in a directory * be within a maildir directory, (the file must be in a directory
* named "new" or "cur" and there must be a neighboring directory * named "new" or "cur" and there must be a neighboring directory
@ -956,11 +959,11 @@ notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
* its filename ends with the sequence ":2," followed by zero or more * its filename ends with the sequence ":2," followed by zero or more
* of the following single-character flags (in ASCII order): * of the following single-character flags (in ASCII order):
* *
* 'D' if the message has the "draft" tag * 'D' iff the message has the "draft" tag
* 'F' if the message has the "flagged" tag * 'F' iff the message has the "flagged" tag
* 'P' if the message has the "passed" tag * 'P' iff the message has the "passed" tag
* 'R' if the message has the "replied" tag * 'R' iff the message has the "replied" tag
* 'S' if the message does not have the "unread" tag * 'S' iff the message does not have the "unread" tag
* *
* Any existing flags unmentioned in the list above are left * Any existing flags unmentioned in the list above are left
* unaffected by the rename. * unaffected by the rename.