changeset 22941:731b91108e05

lib-fs: Update FS_METADATA_WRITE_FNAME comment
author Timo Sirainen <timo.sirainen@dovecot.fi>
date Thu, 26 Apr 2018 18:23:54 +0300
parents c7d47a5c5550
children b91af97dd666
files src/lib-fs/fs-api.h
diffstat 1 files changed, 2 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/lib-fs/fs-api.h	Thu Apr 26 18:14:27 2018 +0300
+++ b/src/lib-fs/fs-api.h	Thu Apr 26 18:23:54 2018 +0300
@@ -15,7 +15,8 @@
 #define FS_METADATA_OBJECTID FS_METADATA_INTERNAL_PREFIX"ObjectID"
 /* Calling this before fs_write_stream_finish() allows renaming the filename.
    This can be useful if you don't know the final filename before writing it
-   (e.g. filename contains the file size). */
+   (e.g. filename contains the file size). The given filename must include the
+   full path also. */
 #define FS_METADATA_WRITE_FNAME FS_METADATA_INTERNAL_PREFIX"WriteFilename"
 /* Original path of the file. The path that's eventually visible to a fs
    backend may be something different, e.g. object ID. This allows the backend