mirrors/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2026-05-05 04:06:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

all: fix duplicate package docs and tighten TestPackageDocs

Browse Source 
TestPackageDocs walked into directories starting with "." (such as
.claude worktrees) and only logged warnings on duplicate package docs
across files in a directory. Skip dot-directories (which covers the
old .git but also .claude), ignore files with "//go:build ignore" so
command files don't falsely trip the duplicate check, and promote the
duplicate-doc warning to a t.Errorf.

While here, deduplicate the package docs that were previously only
logged: drop the redundant comment from client/systray/startup-creator.go,
move the comprehensive taildrop doc into feature/taildrop/doc.go, and
remove a leftover doc fragment from feature/condlite/expvar/omit.go.

The tstest/integration/vms allowlist is no longer needed since the
//go:build ignore filter now handles its dns_tester.go and udp_tester.go
files generically.

Fixes #19526

Change-Id: Id794d96bd728826a1883a054e4a244f90fa05d3d
Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
This commit is contained in:
Brad Fitzpatrick 2026-04-25 01:14:56 +00:00 committed by Brad Fitzpatrick
parent 873b8b8e2e
commit f3b2f9b0ef
5 changed files with 24 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
client/systray/startup-creator.go
View File

@ -3,7 +3,6 @@
//go:build cgo || !darwin
// Package systray provides a minimal Tailscale systray application.
package systray
import (

1
feature/condlite/expvar/omit.go
View File

@ -3,7 +3,6 @@
//go:build ts_omit_debug && ts_omit_clientmetrics && ts_omit_usermetrics
// excluding the package from builds.
package expvar
type Int int64

7
feature/taildrop/doc.go
View File

@ -1,5 +1,10 @@
// Copyright (c) Tailscale Inc & contributors
// SPDX-License-Identifier: BSD-3-Clause
// Package taildrop registers the taildrop (file sending) feature.
// Package taildrop contains the implementation of the Taildrop
// functionality including sending and retrieving files.
// This package does not validate permissions, the caller should
// be responsible for ensuring correct authorization.
//
// For related documentation see: http://go/taildrop-how-does-it-work
package taildrop

6
feature/taildrop/taildrop.go
View File

@ -1,12 +1,6 @@
// Copyright (c) Tailscale Inc & contributors
// SPDX-License-Identifier: BSD-3-Clause
// Package taildrop contains the implementation of the Taildrop
// functionality including sending and retrieving files.
// This package does not validate permissions, the caller should
// be responsible for ensuring correct authorization.
//
// For related documentation see: http://go/taildrop-how-does-it-work
package taildrop
import (

27
pkgdoc_test.go
View File

@ -4,6 +4,7 @@
package tailscaleroot
import (
"go/ast"
"go/parser"
"go/token"
"os"
@ -13,6 +14,17 @@ import (
"testing"
)
func hasIgnoreBuildTag(f *ast.File) bool {
for _, cg := range f.Comments {
for _, c := range cg.List {
if c.Text == "//go:build ignore" {
return true
}
}
}
return false
}
func TestPackageDocs(t *testing.T) {
switch runtime.GOOS {
case "darwin", "linux":
@ -26,8 +38,8 @@ func TestPackageDocs(t *testing.T) {
if err != nil {
return err
}
if fi.Mode().IsDir() && path == ".git" {
return filepath.SkipDir // No documentation lives in .git
if fi.Mode().IsDir() && path != "." && strings.HasPrefix(filepath.Base(path), ".") {
return filepath.SkipDir // No documentation lives in dot directories (.git, .claude, etc)
}
if fi.Mode().IsRegular() && strings.HasSuffix(path, ".go") {
if strings.HasSuffix(path, "_test.go") {
@ -48,6 +60,9 @@ func TestPackageDocs(t *testing.T) {
if err != nil {
t.Fatalf("failed to ParseFile %q: %v", fileName, err)
}
if hasIgnoreBuildTag(f) {
continue
}
dir := filepath.Dir(fileName)
if _, ok := byDir[dir]; !ok {
byDir[dir] = nil
@ -61,14 +76,8 @@ func TestPackageDocs(t *testing.T) {
}
}
for dir, ff := range byDir {
switch dir {
case "tstest/integration/vms":
// This package has a couple go:build ignore commands and this test doesn't
// handle parsing those. Just allowlist that package for now (2024-07-10).
continue
}
if len(ff) > 1 {
t.Logf("multiple files with package doc in %s: %q", dir, ff)
t.Errorf("multiple files with package doc in %s: %q", dir, ff)
}
if len(ff) == 0 {
if strings.HasPrefix(dir, "gokrazy/") {