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>

diff --git a/api/go1.16.txt b/api/go1.16.txt
index 8f9ca55ccd5841d1d0c388dd37f8b68586ec9ae5..11400965d1c9683b4e07563f6dc023f95ec722fb 100644 (file)
--- 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 0d5a9420247449fe9e1654f21ab38b59243db62b..38216ac13fdf79507941ea981ec27bc36075ed2f 100644 (file)
--- 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