1
0
mirror of https://github.com/golang/go synced 2024-11-24 00:30:15 -07:00

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>
This commit is contained in:
Yury Smolsky 2018-02-25 16:34:35 +02:00 committed by Giovanni Bajo
parent fd5bf0393e
commit 3b7ad1680f
2 changed files with 4 additions and 2 deletions

View File

@ -82,7 +82,8 @@ const (
type FileHeader struct { type FileHeader struct {
// Name is the name of the file. // Name is the name of the file.
// It must be a relative path, not start with a drive letter (e.g. C:), // 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 Name string
// Comment is any arbitrary user-defined string shorter than 64KiB. // Comment is any arbitrary user-defined string shorter than 64KiB.

View File

@ -209,7 +209,8 @@ func (w *Writer) Close() error {
// The file contents will be compressed using the Deflate method. // The file contents will be compressed using the Deflate method.
// The name must be a relative path: it must not start with a drive // 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 // 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 // The file's contents must be written to the io.Writer before the next
// call to Create, CreateHeader, or Close. // call to Create, CreateHeader, or Close.
func (w *Writer) Create(name string) (io.Writer, error) { func (w *Writer) Create(name string) (io.Writer, error) {