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: Be honest in the documentation of the maildir functions

Browse source 
I had originally hoped for better semantics, such as doing nothing in
non-maildir directories, and preserving unknown maildir flags that
happen to be present.

We could still do those things, of course, but for now, remove them
from the documentation since the implementation does not do these
things yet.
This commit is contained in:
Carl Worth 2010-11-11 04:51:55 -08:00
parent 89954b453c
commit 1ea0b8bfe1
1 changed files with 7 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
lib/notmuch.h
View file

@ -926,11 +926,8 @@ notmuch_message_remove_all_tags (notmuch_message_t *message);
* For each flag that is not present, the opposite action (add/remove) * For each flag that is not present, the opposite action (add/remove)
* is performed for the corresponding tags. * is performed for the corresponding tags.
* *
* The only filenames examined for flags are filenames which appear to * Flags are identified as trailing components of the filename after a
* be within a maildir directory, (the file must be in a directory * sequence of ":2,".
* named "new" or "cur" and there must be a neighboring directory
* named respectively "cur" or "new"). The flags are identified as
* trailing components of the filename after a sequence of ":2,".
* *
* If there are multiple filenames associated with this message, the * If there are multiple filenames associated with this message, the
* flag is considered present if it appears in one or more * flag is considered present if it appears in one or more
@ -950,14 +947,9 @@ notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
* *
* Specifically, for each filename corresponding to this message: * Specifically, for each filename corresponding to this message:
* *
* If the filename is not in a maildir directory, do nothing. * Rename the file so that its filename ends with the sequence ":2,"
* (A maildir directory is determined as a directory named "new" or * followed by zero or more of the following single-character flags
* "cur" with a neighboring directory named respectively "cur" or * (in ASCII order):
* "new".)
*
* If the filename is in a maildir directory, rename the file so that
* its filename ends with the sequence ":2," followed by zero or more
* of the following single-character flags (in ASCII order):
* *
* 'D' iff the message has the "draft" tag * 'D' iff the message has the "draft" tag
* 'F' iff the message has the "flagged" tag * 'F' iff the message has the "flagged" tag
@ -965,8 +957,8 @@ notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
* 'R' iff the message has the "replied" tag * 'R' iff the message has the "replied" tag
* 'S' iff 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 * Warning: any existing flags unmentioned in the list above will be
* unaffected by the rename. * removed by this renaming.
* *
* Also, if this filename is in a directory named "new", rename it to * Also, if this filename is in a directory named "new", rename it to
* be within the neighboring directory named "cur". * be within the neighboring directory named "cur".