aboutsummaryrefslogtreecommitdiff
path: root/src/encoding/gob
diff options
context:
space:
mode:
authorRob Pike <r@golang.org>2016-04-21 12:43:22 -0700
committerRob Pike <r@golang.org>2016-04-22 00:14:27 +0000
commit8082828ed0b07225c50a991dbe2a176346fba3b8 (patch)
treea87f5d130409a123697981a48883758fc3cc0ce5 /src/encoding/gob
parent70184087239482331a9e4a66627e4458ffe48933 (diff)
downloadgo-8082828ed0b07225c50a991dbe2a176346fba3b8.tar.gz
go-8082828ed0b07225c50a991dbe2a176346fba3b8.zip
encoding/gob: document compatibility
Fixes #13808. Change-Id: Ifbd5644da995a812438a405485c9e08b4503a313 Reviewed-on: https://go-review.googlesource.com/22352 Reviewed-by: Ian Lance Taylor <iant@golang.org>
Diffstat (limited to 'src/encoding/gob')
-rw-r--r--src/encoding/gob/doc.go6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/encoding/gob/doc.go b/src/encoding/gob/doc.go
index cf878f4502..6f86d84891 100644
--- a/src/encoding/gob/doc.go
+++ b/src/encoding/gob/doc.go
@@ -254,6 +254,12 @@ In summary, a gob stream looks like
where * signifies zero or more repetitions and the type id of a value must
be predefined or be defined before the value in the stream.
+Compatibility: Any future changes to the package will endeavor to maintain
+compatibility with streams encoded using previous versions. That is, any released
+version of this package should be able to decode data written with any previously
+released version, subject to issues such as security fixes. See the Go compatibility
+document for background: https://golang.org/doc/go1compat
+
See "Gobs of data" for a design discussion of the gob wire format:
https://blog.golang.org/gobs-of-data
*/