diff options
author | Carl Worth <cworth@cworth.org> | 2010-01-07 09:31:58 -0800 |
---|---|---|
committer | Carl Worth <cworth@cworth.org> | 2010-01-07 09:31:58 -0800 |
commit | 6ed606c19edfe06d2dfd48854fc97f8502eaaf7c (patch) | |
tree | cabb04e5dac99971fbe5d0ff18d2e36eef59aa35 /lib/database.cc | |
parent | a274848f95e3eb074b48d14cf22774c75b80c735 (diff) |
lib: Clarify internal documentation of _notmuch_database_filename_to_direntry
The original wording made it sound like this function was just doing
some string manipulation. But this function actually creates new
directory documents as a side effect. So make that explicit in its
documentation.
Diffstat (limited to 'lib/database.cc')
-rw-r--r-- | lib/database.cc | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/database.cc b/lib/database.cc index dc967c8c..125b37eb 100644 --- a/lib/database.cc +++ b/lib/database.cc @@ -723,6 +723,9 @@ _notmuch_database_get_directory_path (void *ctx, * database path or absolute with initial components identical to * database path), return a new string (with 'ctx' as the talloc * owner) suitable for use as a direntry term value. + * + * The necessary directory documents will be created in the database + * as needed. */ notmuch_status_t _notmuch_database_filename_to_direntry (void *ctx, |