archive/zip: improve Writer.Create documentation on how to add directories

FileHeader.Name also reflects this fact.

Fixes #24018

Change-Id: Id0860a9b23c264ac4c6ddd65ba20e0f1f36e4865
Reviewed-on: https://go-review.googlesource.com/97057
Reviewed-by: Joe Tsai <thebrokentoaster@gmail.com>

diff --git a/src/archive/zip/struct.go b/src/archive/zip/struct.go
index f613ebdc3444f3e71998769216ac52025d327291..36b551ec2c32ade008cbef60dd8c98e002502538 100644 (file)
--- a/src/archive/zip/struct.go
+++ b/src/archive/zip/struct.go
@@ -82,7 +82,8 @@ const (
 type FileHeader struct {
        // Name is the name of the file.
        // It must be a relative path, not start with a drive letter (e.g. C:),
-       // and must use forward slashes instead of back slashes.
+       // and must use forward slashes instead of back slashes. A trailing slash
+       // indicates that this file is a directory and should have no data.
        Name string
 
        // Comment is any arbitrary user-defined string shorter than 64KiB.

diff --git a/src/archive/zip/writer.go b/src/archive/zip/writer.go
index 14a5ee48c117a3af1a99ff75532a3ba160607837..12675d60a0230303dab09cf78f8a6d0b0104baf2 100644 (file)
--- a/src/archive/zip/writer.go
+++ b/src/archive/zip/writer.go
@@ -209,7 +209,8 @@ func (w *Writer) Close() error {
 // The file contents will be compressed using the Deflate method.
 // The name must be a relative path: it must not start with a drive
 // letter (e.g. C:) or leading slash, and only forward slashes are
-// allowed.
+// allowed. To create a directory instead of a file, add a trailing
+// slash to the name.
 // The file's contents must be written to the io.Writer before the next
 // call to Create, CreateHeader, or Close.
 func (w *Writer) Create(name string) (io.Writer, error) {