From a257b2f88b7fd3125425d4953625f6152965b58a Mon Sep 17 00:00:00 2001
From: James Tucker <james@tailscale.com>
Date: Sun, 9 Apr 2023 20:48:12 -0700
Subject: [PATCH] wgengine/magicsock: add immutability documentation to
 endpointDisco

Updates #7825

Signed-off-by: James Tucker <james@tailscale.com>
---
 wgengine/magicsock/magicsock.go | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/wgengine/magicsock/magicsock.go b/wgengine/magicsock/magicsock.go
index 45a8d17d6..2be71a038 100644
--- a/wgengine/magicsock/magicsock.go
+++ b/wgengine/magicsock/magicsock.go
@@ -4085,6 +4085,8 @@ func ippDebugString(ua netip.AddrPort) string {
 // recalculated.
 type endpointSendFunc func([][]byte) error
 
+// endpointDisco is the current disco key and short string for an endpoint. This
+// structure is immutable.
 type endpointDisco struct {
 	key   key.DiscoPublic // for discovery messages.
 	short string          // ShortString of discoKey.