From 64c80129f104a823228e51c0db5a083f3f5c0b3d Mon Sep 17 00:00:00 2001
From: Brad Fitzpatrick <bradfitz@tailscale.com>
Date: Mon, 12 Apr 2021 12:49:23 -0700
Subject: [PATCH] types/netmap: add some docs/warning to NetworkMap

Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
---
 types/netmap/netmap.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/types/netmap/netmap.go b/types/netmap/netmap.go
index 558c74637..5bf1441ac 100644
--- 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