jcarr
/
go-spew
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Deprecate "disableunsafe" tag in favor of "safe". 

This adds a new build tag named "safe" which serves the exact same
purpose as the current "disableunsafe" tag.  This is being done, as
recommended by @shurcooL, since it is emerging as the standard way to do
it in several high profile packages, it mirrors the "unsafe" package
nicely, it is shorter, and users generally seem to prefer it.

However, to avoid breaking existing infrastructure, the disableunsafe
tag is still available and simply is being deprecated.
This commit is contained in:
Dave Collins 2016-09-07 11:21:46 -05:00
parent 66f99a29a0
commit 6d212800a4
6 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.travis.yml
View File

@ -6,7 +6,7 @@ go:
install: install:
- go get -v golang.org/x/tools/cmd/cover - go get -v golang.org/x/tools/cmd/cover
script: script:
- go test -v -tags=disableunsafe ./spew - go test -v -tags=safe ./spew
- go test -v -tags=testcgo ./spew -covermode=count -coverprofile=profile.cov - go test -v -tags=testcgo ./spew -covermode=count -coverprofile=profile.cov
after_success: after_success:
- go get -v github.com/mattn/goveralls - go get -v github.com/mattn/goveralls

8
README.md
View File

@ -157,7 +157,7 @@ options. See the ConfigState documentation for more details.
which only accept pointer receivers from non-pointer variables. This option which only accept pointer receivers from non-pointer variables. This option
relies on access to the unsafe package, so it will not have any effect when relies on access to the unsafe package, so it will not have any effect when
running in environments without access to the unsafe package such as Google running in environments without access to the unsafe package such as Google
App Engine or with the "disableunsafe" build tag specified. App Engine or with the "safe" build tag specified.
Pointer method invocation is enabled by default. Pointer method invocation is enabled by default.
* ContinueOnMethod * ContinueOnMethod
@ -185,9 +185,9 @@ options. See the ConfigState documentation for more details.
This package relies on the unsafe package to perform some of the more advanced This package relies on the unsafe package to perform some of the more advanced
features, however it also supports a "limited" mode which allows it to work in features, however it also supports a "limited" mode which allows it to work in
environments where the unsafe package is not available. By default, it will environments where the unsafe package is not available. By default, it will
operate in this mode on Google App Engine. The "disableunsafe" build tag may operate in this mode on Google App Engine and when compiled with GopherJS. The
also be specified to force the package to build without using the unsafe "safe" build tag may also be specified to force the package to build without
package. using the unsafe package.
## License ## License

5
spew/bypass.go
View File

@ -14,8 +14,9 @@
// NOTE: Due to the following build constraints, this file will only be compiled // NOTE: Due to the following build constraints, this file will only be compiled
// when the code is not running on Google App Engine, compiled by GopherJS, and // when the code is not running on Google App Engine, compiled by GopherJS, and
// "-tags disableunsafe" is not added to the go build command line. // "-tags safe" is not added to the go build command line. The "disableunsafe"
// +build !appengine,!disableunsafe,!js // tag is deprecated and thus should not be used.
// +build !js,!appengine,!safe,!disableunsafe
package spew package spew

5
spew/bypasssafe.go
View File

@ -14,8 +14,9 @@
// NOTE: Due to the following build constraints, this file will only be compiled // NOTE: Due to the following build constraints, this file will only be compiled
// when the code is running on Google App Engine, compiled by GopherJS, or // when the code is running on Google App Engine, compiled by GopherJS, or
// "-tags disableunsafe" is added to the go build command line. // "-tags safe" is added to the go build command line. The "disableunsafe"
// +build appengine disableunsafe js // tag is deprecated and thus should not be used.
// +build js appengine safe disableunsafe
package spew package spew

2
spew/config.go
View File

@ -64,7 +64,7 @@ type ConfigState struct {
// inside these interface methods. As a result, this option relies on // inside these interface methods. As a result, this option relies on
// access to the unsafe package, so it will not have any effect when // access to the unsafe package, so it will not have any effect when
// running in environments without access to the unsafe package such as // running in environments without access to the unsafe package such as
// Google App Engine or with the "disableunsafe" build tag specified. // Google App Engine or with the "safe" build tag specified.
DisablePointerMethods bool DisablePointerMethods bool
// ContinueOnMethod specifies whether or not recursion should continue once // ContinueOnMethod specifies whether or not recursion should continue once

5
spew/internalunsafe_test.go
View File

@ -14,8 +14,9 @@
// NOTE: Due to the following build constraints, this file will only be compiled // NOTE: Due to the following build constraints, this file will only be compiled
// when the code is not running on Google App Engine, compiled by GopherJS, and // when the code is not running on Google App Engine, compiled by GopherJS, and
// "-tags disableunsafe" is not added to the go build command line. // "-tags safe" is not added to the go build command line. The "disableunsafe"
// +build !appengine,!disableunsafe,!js // tag is deprecated and thus should not be used.
// +build !js,!appengine,!safe,!disableunsafe
/* /*
This test file is part of the spew package rather than than the spew_test This test file is part of the spew package rather than than the spew_test