types/netmap: add some docs/warning to NetworkMap

Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
2021-04-12 12:49:23 -07:00 · 2021-04-12 12:49:23 -07:00 · 64c80129f1
parent ccb322db04
commit 64c80129f1
1 changed files with 4 additions and 0 deletions
--- a/types/netmap/netmap.go
+++ b/types/netmap/netmap.go
@ -18,6 +18,10 @@ import (
 	"tailscale.com/wgengine/filter"
 )

+// NetworkMap is the current state of the world.
+//
+// The fields should all be considered read-only. They might
+// alias parts of previous NetworkMap values.
 type NetworkMap struct {
 	// Core networking