summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorapnadkarni <apnmbx-wits@yahoo.com>2023-10-15 11:45:35 (GMT)
committerapnadkarni <apnmbx-wits@yahoo.com>2023-10-15 11:45:35 (GMT)
commit79dbad99aa25a1c2503fe6a0228d1196fcaa8519 (patch)
tree5e1b853d16bf5c9ac64d14995e2780cc270c55c9 /doc
parentab8f66680584cabba56ab7af696818dfa8e2a8e6 (diff)
downloadtcl-79dbad99aa25a1c2503fe6a0228d1196fcaa8519.zip
tcl-79dbad99aa25a1c2503fe6a0228d1196fcaa8519.tar.gz
tcl-79dbad99aa25a1c2503fe6a0228d1196fcaa8519.tar.bz2
Refactor mount_data api as to not duplicate mount command functionality. Needs revisiting as mount_data is not even in TIP 430
Diffstat (limited to 'doc')
-rw-r--r--doc/zipfs.323
1 files changed, 6 insertions, 17 deletions
diff --git a/doc/zipfs.3 b/doc/zipfs.3
index af1281c..571647f 100644
--- a/doc/zipfs.3
+++ b/doc/zipfs.3
@@ -111,23 +111,12 @@ is NULL, the path to the archive mounted at that mount point is stored
as \fIinterp\fR's result. The function returns a standard Tcl result
code.
.PP
-\fBTclZipfs_MountBuffer\fR is similar to \fBTclZipfs_Mount\fR except that the
-content of a ZIP archive is passed in the buffer pointed to by \fIdata\fR.
-If \fImountpoint\fR and
-\fIdata\fR are both non-NULL, the function
-mounts the ZIP archive content \fIdata\fR on the mount point
-given in \fImountpoint\fR.
-The
-\fIcopy\fR argument determines whether the buffer is internally copied before
-mounting or not. The ZIP archive is assumed to be not password protected.
-On success, \fIinterp\fR's result is set to the normalized mount point
-path.
-If \fImountpoint\fR is a NULL pointer, information on all currently mounted ZIP
-file systems is stored in \fIinterp\fR's result as a sequence of mount
-points and ZIP file names. If \fImountpoint\fR is not NULL but \fIdata\fR
-is NULL, the path to the archive mounted at that mount point is stored
-as \fIinterp\fR's result. The function returns a standard Tcl result
-code.
+\fBTclZipfs_MountBuffer\fR mounts the ZIP archive content \fIdata\fR on the
+mount point given in \fImountpoint\fR. Both \fImountpoint\fR and \fIdata\fR must
+be specified as non-NULL. The \fIcopy\fR argument determines whether the buffer
+is internally copied before mounting or not. The ZIP archive is assumed to be
+not password protected. On success, \fIinterp\fR's result is set to the
+normalized mount point path.
.PP
\fBTclZipfs_Unmount\fR undoes the effect of \fBTclZipfs_Mount\fR, i.e., it
unmounts the mounted ZIP file system that was mounted from \fIzipname\fR (at