mirror
/
go
mirror of https://github.com/golang/go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

archive/zip: use proper doc comment for Deprecated notes 

End-of-line comments are not doc comments,
so Deprecated notes in them are not recognized
as deprecation notices. Rewrite the comments.

Change-Id: Idc4681924f9a7e9ead62f672ef8a763e70db1f0f
Reviewed-on: https://go-review.googlesource.com/c/go/+/453616
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Joseph Tsai <joetsai@digital-static.net>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Run-TryBot: Russ Cox <rsc@golang.org>
Auto-Submit: Russ Cox <rsc@golang.org>
This commit is contained in:
Russ Cox 2022-11-28 11:02:23 -05:00 committed by Gopher Robot
parent d71b1c3dcc
commit 5a4e440f48
2 changed files with 46 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api/go1.16.txt
View File

@ -506,6 +506,10 @@ pkg archive/zip, method (*File) ModTime //deprecated
pkg archive/zip, method (*File) SetModTime //deprecated pkg archive/zip, method (*File) SetModTime //deprecated
pkg archive/zip, method (*FileHeader) ModTime //deprecated pkg archive/zip, method (*FileHeader) ModTime //deprecated
pkg archive/zip, method (*FileHeader) SetModTime //deprecated pkg archive/zip, method (*FileHeader) SetModTime //deprecated
pkg archive/zip, type FileHeader struct, CompressedSize //deprecated
pkg archive/zip, type FileHeader struct, ModifiedDate //deprecated
pkg archive/zip, type FileHeader struct, ModifiedTime //deprecated
pkg archive/zip, type FileHeader struct, UncompressedSize //deprecated
pkg compress/flate, type ReadError //deprecated pkg compress/flate, type ReadError //deprecated
pkg compress/flate, type WriteError //deprecated pkg compress/flate, type WriteError //deprecated
pkg crypto/rc4, method (*Cipher) Reset //deprecated pkg crypto/rc4, method (*Cipher) Reset //deprecated

54
src/archive/zip/struct.go
View File

@ -5,7 +5,7 @@
/* /*
Package zip provides support for reading and writing ZIP archives. Package zip provides support for reading and writing ZIP archives.
See: https://www.pkware.com/appnote See the [ZIP specification] for details.
This package does not support disk spanning. This package does not support disk spanning.
@ -16,6 +16,8 @@ fields. The 64 bit fields will always contain the correct value and
for normal archives both fields will be the same. For files requiring for normal archives both fields will be the same. For files requiring
the ZIP64 format the 32 bit fields will be 0xffffffff and the 64 bit the ZIP64 format the 32 bit fields will be 0xffffffff and the 64 bit
fields must be used instead. fields must be used instead.
[ZIP specification]: https://www.pkware.com/appnote
*/ */
package zip package zip
@ -77,8 +79,10 @@ const (
infoZipUnixExtraID = 0x5855 // Info-ZIP Unix extension infoZipUnixExtraID = 0x5855 // Info-ZIP Unix extension
) )
// FileHeader describes a file within a zip file. // FileHeader describes a file within a ZIP file.
// See the zip spec for details. // See the [ZIP specification] for details.
//
// [ZIP specification]: https://www.pkware.com/appnote
type FileHeader struct { type FileHeader struct {
// Name is the name of the file. // Name is the name of the file.
// //
@ -117,17 +121,43 @@ type FileHeader struct {
// When writing, an extended timestamp (which is timezone-agnostic) is // When writing, an extended timestamp (which is timezone-agnostic) is
// always emitted. The legacy MS-DOS date field is encoded according to the // always emitted. The legacy MS-DOS date field is encoded according to the
// location of the Modified time. // location of the Modified time.
Modified time.Time Modified time.Time
ModifiedTime uint16 // Deprecated: Legacy MS-DOS date; use Modified instead.
ModifiedDate uint16 // Deprecated: Legacy MS-DOS time; use Modified instead.
CRC32 uint32 // ModifiedTime is an MS-DOS-encoded time.
CompressedSize uint32 // Deprecated: Use CompressedSize64 instead. //
UncompressedSize uint32 // Deprecated: Use UncompressedSize64 instead. // Deprecated: Use Modified instead.
CompressedSize64 uint64 ModifiedTime uint16
// ModifiedDate is an MS-DOS-encoded date.
//
// Deprecated: Use Modified instead.
ModifiedDate uint16
// CRC32 is the CRC32 checksum of the file content.
CRC32 uint32
// CompressedSize is the compressed size of the file in bytes.
// If either the uncompressed or compressed size of the file
// does not fit in 32 bits, CompressedSize is set to ^uint32(0).
//
// Deprecated: Use CompressedSize64 instead.
CompressedSize uint32
// UncompressedSize is the compressed size of the file in bytes.
// If either the uncompressed or compressed size of the file
// does not fit in 32 bits, CompressedSize is set to ^uint32(0).
//
// Deprecated: Use UncompressedSize64 instead.
UncompressedSize uint32
// CompressedSize64 is the compressed size of the file in bytes.
CompressedSize64 uint64
// UncompressedSize64 is the uncompressed size of the file in bytes.
UncompressedSize64 uint64 UncompressedSize64 uint64
Extra []byte
ExternalAttrs uint32 // Meaning depends on CreatorVersion Extra []byte
ExternalAttrs uint32 // Meaning depends on CreatorVersion
} }
// FileInfo returns an fs.FileInfo for the FileHeader. // FileInfo returns an fs.FileInfo for the FileHeader.