Skip to content

Mark win* GODEBUG settings as Windows-only (#3) #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GillMacedo merged 1 commit into from
Nov 2, 2026
Merged

Mark win* GODEBUG settings as Windows-only (#3) #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 25 additions & 12 deletions plugin/scripts/godebugdiff.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,16 @@ type Binary struct {

// Change is one GODEBUG setting whose default differs between the two go lines.
type Change struct {
Name string `json:"name"`
Package string `json:"package"`
Changed int `json:"changedIn,omitempty"`
Before string `json:"before"` // value, or "" for the toolchain default
After string `json:"after"`
ReachedBy []string `json:"reachedBy"` // binaries that import Package
GoCommand bool `json:"goCommand"` // the setting controls the go command, not binaries
Doc string `json:"doc,omitempty"`
URL string `json:"url,omitempty"`
Name string `json:"name"`
Package string `json:"package"`
Changed int `json:"changedIn,omitempty"`
Before string `json:"before"` // value, or "" for the toolchain default
After string `json:"after"`
ReachedBy []string `json:"reachedBy"` // binaries that import Package
GoCommand bool `json:"goCommand"` // the setting controls the go command, not binaries
WindowsOnly bool `json:"windowsOnly,omitempty"` // name starts with win; Linux services can skip
Doc string `json:"doc,omitempty"`
URL string `json:"url,omitempty"`
}

// Result is the full comparison.
Expand Down Expand Up @@ -552,6 +553,7 @@ func compare(before, after []Binary, table map[string]Setting, docs map[string][
s := table[k]
c = &Change{Name: k, Package: s.Package, Changed: s.Changed, Before: bv, After: av, ReachedBy: []string{}}
c.GoCommand = strings.HasPrefix(s.Package, "cmd/")
c.WindowsOnly = isWindowsOnly(k)
if d, ok := pickDoc(docs[k], s.Changed); ok {
c.Doc, c.URL = d.Text, d.URL
if c.Changed == 0 {
Expand Down Expand Up @@ -779,7 +781,7 @@ func Print(w io.Writer, r *Result) {
len(reached), plural(len(reached), "reaches", "reach"), kind)
for _, c := range reached {
fmt.Fprintln(w)
fmt.Fprintf(w, "%s %s -> %s %s, %s\n", c.Name, value(c.Before), value(c.After), changedIn(c), c.Package)
fmt.Fprintf(w, "%s %s -> %s %s, %s%s\n", c.Name, value(c.Before), value(c.After), changedIn(c), c.Package, windowsOnlyNote(c))
fmt.Fprintf(w, " imported by %s\n", who(c.ReachedBy, len(r.Binaries), kind))
if c.Doc != "" {
fmt.Fprintf(w, " %s\n", c.Doc)
Expand All @@ -791,7 +793,7 @@ func Print(w io.Writer, r *Result) {
if len(gocmd) > 0 {
fmt.Fprintf(w, "\nChanges the go command, not your %s:\n", kind)
for _, c := range gocmd {
fmt.Fprintf(w, " %s %s -> %s %s\n", c.Name, value(c.Before), value(c.After), changedIn(c))
fmt.Fprintf(w, " %s %s -> %s %s%s\n", c.Name, value(c.Before), value(c.After), changedIn(c), windowsOnlyNote(c))
if c.Doc != "" {
fmt.Fprintf(w, " %s\n", c.Doc)
}
Expand All @@ -804,7 +806,7 @@ func Print(w io.Writer, r *Result) {
if pkg == "" {
pkg = "package unknown"
}
fmt.Fprintf(w, " %s (%s)\n", c.Name, pkg)
fmt.Fprintf(w, " %s (%s)%s\n", c.Name, pkg, windowsOnlyNote(c))
}
}
var pins []string
Expand Down Expand Up @@ -846,6 +848,17 @@ func who(bins []string, total int, kind string) string {
return strings.Join(bins, ", ")
}

func isWindowsOnly(name string) bool {
return strings.HasPrefix(name, "win")
}

func windowsOnlyNote(c Change) string {
if !c.WindowsOnly {
return ""
}
return " (Windows only)"
}

func plural(n int, one, many string) string {
if n == 1 {
return one
Expand Down
27 changes: 27 additions & 0 deletions plugin/scripts/godebugdiff_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package main

import (
"bytes"
"encoding/json"
"os"
"os/exec"
"path/filepath"
Expand Down Expand Up @@ -246,3 +247,29 @@ func run1(t *testing.T, name string, args ...string) string {
}
return string(out)
}

func TestWindowsOnly(t *testing.T) {
if !isWindowsOnly("winsymlink") || !isWindowsOnly("winreadlinkvolume") {
t.Fatal("win* settings should be Windows-only")
}
if isWindowsOnly("httpmuxgo121") || isWindowsOnly("asynctimerchan") {
t.Fatal("non-win settings must not be marked Windows-only")
}
c := Change{Name: "winsymlink", Package: "os", Before: "0", After: "1", WindowsOnly: true, ReachedBy: []string{"x"}}
var buf bytes.Buffer
Print(&buf, &Result{
Module: "x", From: "1.22", To: "1.23", Toolchain: "go1.23.0",
Binaries: []string{"x"}, Changes: []Change{c},
})
out := buf.String()
if !strings.Contains(out, "winsymlink") || !strings.Contains(out, "(Windows only)") {
t.Fatalf("text report missing Windows-only mark:\n%s", out)
}
enc, err := json.Marshal(c)
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(enc), `"windowsOnly":true`) {
t.Fatalf("JSON missing windowsOnly: %s", enc)
}
}