1
0
mirror of https://github.com/golang/go synced 2024-11-11 19:01:37 -07:00

archive/tar: 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: Idb19603d7fc2ec8e3a2f74bacb74fbbec5583d20
Reviewed-on: https://go-review.googlesource.com/c/go/+/453615
TryBot-Result: Gopher Robot <gobot@golang.org>
Auto-Submit: Russ Cox <rsc@golang.org>
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Joseph Tsai <joetsai@digital-static.net>
Reviewed-by: Ian Lance Taylor <iant@google.com>
This commit is contained in:
Russ Cox 2022-11-28 11:01:36 -05:00 committed by Gopher Robot
parent 1711f953e4
commit d71b1c3dcc
2 changed files with 5 additions and 2 deletions

View File

@ -500,6 +500,7 @@ pkg unicode, var Dives_Akuru *RangeTable
pkg unicode, var Khitan_Small_Script *RangeTable
pkg unicode, var Yezidi *RangeTable
# all deprecations up to and including Go 1.16
pkg archive/tar, const TypeRegA //deprecated
pkg archive/tar, type Header struct, Xattrs //deprecated
pkg archive/zip, method (*File) ModTime //deprecated
pkg archive/zip, method (*File) SetModTime //deprecated

View File

@ -59,8 +59,10 @@ func (he headerError) Error() string {
// Type flags for Header.Typeflag.
const (
// Type '0' indicates a regular file.
TypeReg = '0'
TypeRegA = '\x00' // Deprecated: Use TypeReg instead.
TypeReg = '0'
// Deprecated: Use TypeReg instead.
TypeRegA = '\x00'
// Type '1' to '6' are header-only flags and may not have a data body.
TypeLink = '1' // Hard link