rsp2k/headscale
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

all: apply godoc [Name] link conventions across comments

Browse source 
Every Go-identifier reference in // and /* */ comments now uses
godoc's [Name] linking syntax so pkg.go.dev and `go doc` render
them as clickable cross-references. No behaviour change.

Pattern applied across the tree:
  In-package         [Foo], [Foo.Bar]
  Cross-package      [pkg.Foo], [pkg.Foo.Bar]
  Stdlib             [netip.Prefix], [errors.Is], [context.Context]
  Tailscale          [tailcfg.MapResponse], [tailcfg.Node.CapMap],
                     [tailcfg.NodeAttrSuggestExitNode]

Skip rules:
  - File:line refs left as plain text
  - HuJSON wire keys inside backtick raw strings untouched
  - ACL/policy syntax tokens (tag:foo, autogroup:self, ...) not Go
    symbols, left as plain text
  - JSON/OIDC wire keys, gorm tags, RFC IPv6 placeholders, markdown
    link tags, decorative dividers — all left as-is
This commit is contained in:
Kristoffer Dalby 2026-05-18 18:35:53 +00:00
parent 17236fd284
commit 4cca63155d
124 changed files with 1037 additions and 1011 deletions
Download patch file Download diff file Expand all files Collapse all files

12
tools/capver/main.go
View file

@ -197,7 +197,7 @@ func getCapabilityVersions(ctx context.Context) (map[string]tailcfg.CapabilityVe
minorVersions := getMinorVersionsFromTags(tags)
log.Printf("Found %d minor versions", len(minorVersions))
// Regular expression to find the CurrentCapabilityVersion line
// Regular expression to find the [tailcfg.CurrentCapabilityVersion] line
re := regexp.MustCompile(`const CurrentCapabilityVersion CapabilityVersion = (\d+)`)
versions := make(map[string]tailcfg.CapabilityVersion)
@ -231,7 +231,7 @@ func getCapabilityVersions(ctx context.Context) (map[string]tailcfg.CapabilityVe
continue
}
// Find the CurrentCapabilityVersion
// Find the [tailcfg.CurrentCapabilityVersion]
matches := re.FindStringSubmatch(string(body))
if len(matches) > 1 {
capabilityVersionStr := matches[1]
@ -306,11 +306,11 @@ func writeCapabilityVersionsToFile(versions map[string]tailcfg.CapabilityVersion
content.WriteString("}\n\n")
// Add the SupportedMajorMinorVersions constant
// Add the [capver.SupportedMajorMinorVersions] constant
content.WriteString("// SupportedMajorMinorVersions is the number of major.minor Tailscale versions supported.\n")
fmt.Fprintf(&content, "const SupportedMajorMinorVersions = %d\n\n", supportedMajorMinorVersions)
// Add the MinSupportedCapabilityVersion constant
// Add the [capver.MinSupportedCapabilityVersion] constant
content.WriteString("// MinSupportedCapabilityVersion represents the minimum capability version\n")
content.WriteString("// supported by this Headscale instance (latest 10 minor versions)\n")
fmt.Fprintf(&content, "const MinSupportedCapabilityVersion tailcfg.CapabilityVersion = %d\n", minSupportedCapVer)
@ -348,7 +348,7 @@ func writeTestDataFile(versions map[string]tailcfg.CapabilityVersion, minSupport
content.WriteString("// Generated DO NOT EDIT\n\n")
content.WriteString("import \"tailscale.com/tailcfg\"\n\n")
// Generate complete test struct for TailscaleLatestMajorMinor
// Generate complete test struct for [capver.TailscaleLatestMajorMinor]
content.WriteString("var tailscaleLatestMajorMinorTests = []struct {\n")
content.WriteString("\tn int\n")
content.WriteString("\tstripV bool\n")
@ -409,7 +409,7 @@ func writeTestDataFile(versions map[string]tailcfg.CapabilityVersion, minSupport
}
}
// Generate complete test struct for CapVerMinimumTailscaleVersion
// Generate complete test struct for [capver.CapVerMinimumTailscaleVersion]
content.WriteString("var capVerMinimumTailscaleVersionTests = []struct {\n")
content.WriteString("\tinput tailcfg.CapabilityVersion\n")
content.WriteString("\texpected string\n")