Changeset 13016

Timestamp:

11/10/10 21:13:42 (13 years ago)

Author:

Mark Evenson

Message:

Improve docstring for SYS:ZIP.

File:

• trunk/abcl/src/org/armedbear/lisp/zip.java (modified) (1 diff)

trunk/abcl/src/org/armedbear/lisp/zip.java

@@ -45 +45 @@
 import java.util.zip.ZipOutputStream;
 
-// ### zip pathname pathnames
+@DocString(name="zip",
+           args="pathname pathnames &optional topdir",
+           doc="Creates a zip archive at PATHNAME whose entries enumerated via the list of PATHNAMES.\n"
+           + "If the optional TOPDIR argument is specified, the archive will "
+           + "preserve the hierarchy of PATHNAMES relative to TOPDIR.  Without "
+           + "TOPDIR, there will be no sub-directories in the archive, i.e. it will "
+           + "be flat.")
 public final class zip extends Primitive
 {
     private zip()
     {
-        super("zip", PACKAGE_SYS, true, "pathname pathnames &optional topdir");
+        super("zip", PACKAGE_SYS, true);
     }
 
     @Override
     public LispObject execute(LispObject first, LispObject second)
-
     {
         Pathname zipfilePathname = coerceToPathname(first);