From: Carl Worth <cworth@cworth.org>
Date: Thu, 7 Jan 2010 17:31:58 +0000 (-0800)
Subject: lib: Clarify internal documentation of _notmuch_database_filename_to_direntry
X-Git-Tag: 0.1~156
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=6ed606c19edfe06d2dfd48854fc97f8502eaaf7c;p=notmuch.git

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.
---

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,