Merge 8.7 (change in order of mount args)

5 files changed, 44 insertions, 36 deletions

diff --git a/doc/FindExec.3 b/doc/FindExec.3
index 7f8c8a4..6156382 100644
--- a/doc/FindExec.3
+++ b/doc/FindExec.3
@@ -35,8 +35,8 @@ Tcl.  For example, it is needed on some platforms in the
 implementation of the \fBload\fR command.
 It is also returned by the \fBinfo nameofexecutable\fR command.
 .PP
-The result of \fBTcl_FindExecutable\fR is the full Tcl version (e.g.,
-\fB8.7.0+abcdef...abcdef.gcc-1002.utf16\fR).
+The result of \fBTcl_FindExecutable\fR is the full Tcl version with build
+information (e.g., \fB8.7.0+abcdef...abcdef.gcc-1002\fR).
 .PP
 On UNIX platforms this procedure is typically invoked as the very
 first thing in the application's main program;  it must be passed
diff --git a/doc/InitSubSyst.3 b/doc/InitSubSyst.3
index 89f2b88..0d09a41 100644
--- a/doc/InitSubSyst.3
+++ b/doc/InitSubSyst.3
@@ -21,8 +21,8 @@ The \fBTcl_InitSubsystems\fR procedure initializes the Tcl
 library. This procedure is typically invoked as the very
 first thing in the application's main program.
 .PP
-The result of \fBTcl_InitSubsystems\fR is the full Tcl version (e.g.,
-\fB8.7.0+abcdef...abcdef.gcc-1002.utf16\fR).
+The result of \fBTcl_InitSubsystems\fR is the full Tcl version with build
+information (e.g., \fB8.7.0+abcdef...abcdef.gcc-1002\fR).
 .PP
 \fBTcl_InitSubsystems\fR is very similar in use to
 \fBTcl_FindExecutable\fR. It can be used when Tcl is
diff --git a/doc/Panic.3 b/doc/Panic.3
index bd019db..5abe1dd 100644
--- a/doc/Panic.3
+++ b/doc/Panic.3
@@ -82,8 +82,8 @@ making calls into the Tcl library, or into other libraries that may
 call the Tcl library, since the original call to \fBTcl_Panic\fR
 indicates the Tcl library is not in a state of reliable operation.
 .PP
-The result of \fBTcl_SetPanicProc\fR is the full Tcl version (e.g.,
-\fB8.7.0+abcdef...abcdef.gcc-1002.utf16\fR).
+The result of \fBTcl_SetPanicProc\fR is the full Tcl version with build
+information (e.g., \fB8.7.0+abcdef...abcdef.gcc-1002\fR).
 .PP
 The typical use of \fBTcl_SetPanicProc\fR arranges for the error message
 to be displayed or reported in a manner more suitable for the
diff --git a/doc/zipfs.3 b/doc/zipfs.3
index 3b13cd9..77a6a57 100644
--- a/doc/zipfs.3
+++ b/doc/zipfs.3
@@ -10,20 +10,20 @@
 .so man.macros
 .BS
 .SH NAME
-TclZipfs_AppHook, Tclzipfs_Mount, TclZipfs_MountBuffer, Tclzipfs_Unmount \- handle ZIP files as Tcl virtual filesystems
+TclZipfs_AppHook, TclZipfs_Mount, TclZipfs_MountBuffer, TclZipfs_Unmount \- handle ZIP files as Tcl virtual filesystems
 .SH SYNOPSIS
 .nf
 const char *
 \fBTclZipfs_AppHook(\fIargcPtr, argvPtr\fR)
 .sp
 int
-\fBTclzipfs_Mount\fR(\fIinterp, mountpoint, zipname, password\fR)
+\fBTclZipfs_Mount\fR(\fIinterp, zipname, mountpoint, password\fR)
 .sp
 int
-\fBTclZipfs_MountBuffer\fR(\fIinterp, mountpoint, data, dataLen, copy\fR)
+\fBTclZipfs_MountBuffer\fR(\fIinterp, data, dataLen, mountpoint, copy\fR)
 .sp
 int
-\fBTclzipfs_Unmount\fR(\fIinterp, mountpoint\fR)
+\fBTclZipfs_Unmount\fR(\fIinterp, mountpoint\fR)
 .fi
 .SH ARGUMENTS
 .AS Tcl_Interp *mountpoint in
@@ -43,7 +43,7 @@ Name of a mount point, which must be a legal Tcl file or directory name. May
 be NULL to query current mount points.
 .AP "const char" *password in
 An (optional) password. Use NULL if no password is wanted to read the file.
-.AP "unsigned char" *data in
+.AP "const void" *data in
 A data buffer to mount. The data buffer must hold the contents of a ZIP
 archive, and must not be NULL.
 .AP size_t dataLen in
@@ -60,10 +60,8 @@ initialization procedures, taking into account available ZIP archives as
 follows:
 .IP [1]
 If the current application has a mountable ZIP archive, that archive is
-mounted under \fIZIPFS_VOLUME\fB/app\fR as a read-only Tcl virtual file
-system. \fIZIPFS_VOLUME\fR is usually \fB//zipfs:\fR on all platforms, but
-\fBzipfs:\fR may also be used on Windows (due to differences in the
-platform's filename parsing).
+mounted under \fIZIPFS_VOLUME\fBapp\fR as a read-only Tcl virtual file
+system. \fIZIPFS_VOLUME\fR is \fB//zipfs:/\fR on all platforms.
 .IP [2]
 If a file named \fBmain.tcl\fR is located in the root directory of that file
 system (i.e., at \fIZIPROOT\fB/app/main.tcl\fR after the ZIP archive is
@@ -87,13 +85,13 @@ it uses WCHAR instead of char. As a result, it requires your application to
 be compiled with the UNICODE preprocessor symbol defined (e.g., via the
 \fB-DUNICODE\fR compiler flag).
 .PP
-The result of \fBTclZipfs_AppHook\fR is the full Tcl version (e.g.,
-\fB8.7.0+abcdef...abcdef.gcc-1002.utf16\fR).
+The result of \fBTclZipfs_AppHook\fR is the full Tcl version with build
+information (e.g., \fB8.7.0+abcdef...abcdef.gcc-1002\fR).
 The function \fImay\fR modify the variables pointed to by \fIargcPtr\fR and
 \fIargvPtr\fR to remove arguments; the current implementation does not do so,
 but callers \fIshould not\fR assume that this will be true in the future.
 .PP
-\fBTclzipfs_Mount\fR mounts the ZIP archive \fIzipname\fR on the mount point
+\fBTclZipfs_Mount\fR mounts the ZIP archive \fIzipname\fR on the mount point
 given in \fImountpoint\fR using the optional ZIP password \fIpassword\fR.
 Errors during that process are reported in the interpreter \fIinterp\fR.  If
 \fImountpoint\fR is a NULL pointer, information on all currently mounted ZIP
@@ -101,14 +99,14 @@ file systems is written into \fIinterp\fR's result as a sequence of mount
 points and ZIP file names.  The result of this call is a standard Tcl result
 code.
 .PP
-\fBTclzipfs_MountBuffer\fR mounts the ZIP archive in the buffer pointed to by
+\fBTclZipfs_MountBuffer\fR mounts the ZIP archive in the buffer pointed to by
 \fIdata\fR on the mount point given in \fImountpoint\fR. The ZIP archive is
 assumed to be not password protected.  Errors during that process are reported
 in the interpreter \fIinterp\fR. The \fIcopy\fR argument determines whether
 the buffer is internally copied before mounting or not. The result of this
 call is a standard Tcl result code.
 .PP
-\fBTclzipfs_Unmount\fR undoes the effect of \fBTclzipfs_Mount\fR, i.e., it
+\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
 \fImountpoint\fR). Errors are reported in the interpreter \fIinterp\fR.  The
 result of this call is a standard Tcl result code.
diff --git a/doc/zipfs.n b/doc/zipfs.n
index b37702a..2768f23 100644
--- a/doc/zipfs.n
+++ b/doc/zipfs.n
@@ -26,12 +26,12 @@ zipfs \- Mount and work with ZIP files within Tcl
 \fBzipfs mkimg\fR \fIoutfile indir\fR ?\fIstrip\fR? ?\fIpassword\fR? ?\fIinfile\fR?
 \fBzipfs mkkey\fR \fIpassword\fR
 \fBzipfs mkzip\fR \fIoutfile indir\fR ?\fIstrip\fR? ?\fIpassword\fR?
-\fBzipfs mount\fR ?\fImountpoint\fR? ?\fIzipfile\fR? ?\fIpassword\fR?
+\fBzipfs mount\fR ?\fIzipfile\fR? ?\fImountpoint\fR? ?\fIpassword\fR?
 \fBzipfs root\fR
 \fBzipfs unmount\fR \fImountpoint\fR
 .fi
 '\" The following subcommand is *UNDOCUMENTED*
-'\" \fBzipfs mount_data\fR ?\fImountpoint\fR? ?\fIdata\fR?
+'\" \fBzipfs mount_data\fR ?\fIdata\fR ?\fImountpoint\fR??
 .BE
 .SH DESCRIPTION
 .PP
@@ -84,16 +84,27 @@ Return a list of all files in the mounted zipfs, or just those matching
 \fIpattern\fR (optionally controlled by the option parameters).  The order of
 the names in the list is arbitrary.
 .TP
-\fBzipfs mount\fR ?\fImountpoint\fR? ?\fIzipfile\fR? ?\fIpassword\fR?
-.
-The \fBzipfs mount\fR command mounts a ZIP archive file as a Tcl virtual
-filesystem at \fImountpoint\fR.  After this command executes, files contained
-in \fIzipfile\fR will appear to Tcl to be regular files at the mount point.
+\fBzipfs mount\fR
+.TP
+\fBzipfs mount\fR \fImountpoint\fR
+.TP
+\fBzipfs mount\fR \fIzipfile\fR \fImountpoint\fR ?\fIpassword\fR?
 .RS
 .PP
-With no \fIzipfile\fR, returns the zipfile mounted at \fImountpoint\fR.  With
-no \fImountpoint\fR, return all zipfile/mount pairs.  If \fImountpoint\fR is
-specified as an empty string, mount on file path.
+The \fBzipfs mount\fR command mounts ZIP archives as Tcl virtual file systems
+and returns information about current mounts.
+.PP
+With no arguments, the command returns a dictionary mapping
+current mount points to the file path of the corresponding ZIP archive.
+.PP
+In the single argument form, the command returns the file path
+of the ZIP archive mounted at the specified mount point.
+.PP
+In the third form, the command mounts the ZIP archive \fIzipfile\fR as a Tcl virtual
+filesystem at \fImountpoint\fR.  After this command executes, files contained
+in \fIzipfile\fR will appear to Tcl to be regular files at the mount point.
+If \fImountpoint\fR is
+specified as an empty string, it is defaulted to the file path.
 .PP
 \fBNB:\fR because the current working directory is a concept maintained by the
 operating system, using \fBcd\fR into a mounted archive will only work in the
@@ -106,9 +117,8 @@ to access the files inside the mount).
 \fBzipfs root\fR
 .
 Returns a constant string which indicates the mount point for zipfs volumes
-for the current platform. On Windows, this value is
-.QW \fBzipfs:/\fR .
-On Unix, this value is
+for the current platform.
+This value is
 .QW \fB//zipfs:/\fR .
 .TP
 \fBzipfs unmount \fImountpoint\fR
@@ -191,13 +201,13 @@ before unmounting it again:
 set zip myApp.zip
 set base [file join [\fBzipfs root\fR] myApp]
 
-\fBzipfs mount\fR $base $zip
+\fBzipfs mount\fR $zip $base
 # $base now has the contents of myApp.zip
 
 source [file join $base app.tcl]
 # use the contents, load libraries from it, etc...
 
-\fBzipfs unmount\fR $zip
+\fBzipfs unmount\fR $base
 .CE
 .PP
 Creating a ZIP archive, given that a directory exists containing the content
@@ -224,7 +234,7 @@ set base [file join [\fBzipfs root\fR] myApp]
 \fBzipfs mkzip\fR $targetZip $sourceDir $sourceDir $password
 
 # Mount with password
-\fBzipfs mount\fR $base $zip $password
+\fBzipfs mount\fR $zip $base $password
 .CE
 .PP
 When creating an executable image with a password, the password is placed