aboutsummaryrefslogtreecommitdiff
path: root/include/sqfs/io.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/sqfs/io.h')
-rw-r--r--include/sqfs/io.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/include/sqfs/io.h b/include/sqfs/io.h
index 578c4fb..18c6810 100644
--- a/include/sqfs/io.h
+++ b/include/sqfs/io.h
@@ -63,6 +63,11 @@ typedef enum {
* @extends sqfs_object_t
*
* @brief Abstracts file I/O to make it easy to embedd SquashFS.
+ *
+ * Files are only copyable if they are read only, i.e. if a file has been
+ * opened with write access, @ref sqfs_copy will always return NULL. The
+ * other data types inside libsquashfs assume this to hold for all
+ * implementations of this interface.
*/
struct sqfs_file_t {
sqfs_object_t base;