aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRuss Cox <rsc@golang.org>2022-11-28 11:01:36 -0500
committerGopher Robot <gobot@golang.org>2022-12-02 16:30:19 +0000
commitd71b1c3dcc2039f44fb2e3f271997ee260e6685b (patch)
tree2bcb70f1ff67ec6dd71f306ebddbe9d7c1066966
parent1711f953e48c3de0f85726cb0299c0c0f0b928a1 (diff)
downloadgo-d71b1c3dcc2039f44fb2e3f271997ee260e6685b.tar.gz
go-d71b1c3dcc2039f44fb2e3f271997ee260e6685b.zip
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>
-rw-r--r--api/go1.16.txt1
-rw-r--r--src/archive/tar/common.go6
2 files changed, 5 insertions, 2 deletions
diff --git a/api/go1.16.txt b/api/go1.16.txt
index 8f9ca55ccd..11400965d1 100644
--- a/api/go1.16.txt
+++ b/api/go1.16.txt
@@ -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
diff --git a/src/archive/tar/common.go b/src/archive/tar/common.go
index 0d5a942024..38216ac13f 100644
--- a/src/archive/tar/common.go
+++ b/src/archive/tar/common.go
@@ -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