all: remove unnecessary trailing newlines in format patterns for consistency

And document on logger.Logf that it's unnecessary.
This commit is contained in:
Brad Fitzpatrick
2020-04-11 08:35:34 -07:00
parent a7e7c7b548
commit 45f2b53aca
10 changed files with 102 additions and 102 deletions
+1 -1
View File
@@ -62,7 +62,7 @@ func (h *Handle) Reset() {
func (h *Handle) notify(n Notify) {
h.mu.Lock()
if n.BackendLogID != nil {
h.logf("Handle: logs: be:%v fe:%v\n",
h.logf("Handle: logs: be:%v fe:%v",
*n.BackendLogID, h.frontendLogID)
}
if n.State != nil {
+12 -13
View File
@@ -14,7 +14,6 @@ import (
"os"
"os/exec"
"os/signal"
"strings"
"sync"
"syscall"
"time"
@@ -64,17 +63,17 @@ type Options struct {
}
func pump(logf logger.Logf, ctx context.Context, bs *ipn.BackendServer, s net.Conn) {
defer logf("Control connection done.\n")
defer logf("Control connection done.")
for ctx.Err() == nil && !bs.GotQuit {
msg, err := ipn.ReadMsg(s)
if err != nil {
logf("ReadMsg: %v\n", err)
logf("ReadMsg: %v", err)
break
}
err = bs.GotCommandMsg(msg)
if err != nil {
logf("GotCommandMsg: %v\n", err)
logf("GotCommandMsg: %v", err)
break
}
}
@@ -97,7 +96,7 @@ func Run(rctx context.Context, logf logger.Logf, logid string, opts Options, e w
}
listen.Close()
}()
logf("Listening on %v\n", listen.Addr())
logf("Listening on %v", listen.Addr())
var store ipn.StateStore
if opts.StatePath != "" {
@@ -170,11 +169,11 @@ func Run(rctx context.Context, logf logger.Logf, logid string, opts Options, e w
for i := 1; rctx.Err() == nil; i++ {
s, err = listen.Accept()
if err != nil {
logf("%d: Accept: %v\n", i, err)
logf("%d: Accept: %v", i, err)
bo.BackOff(rctx, err)
continue
}
logf("%d: Incoming control connection.\n", i)
logf("%d: Incoming control connection.", i)
stopAll()
ctx, cancel = context.WithCancel(rctx)
@@ -217,10 +216,10 @@ func BabysitProc(ctx context.Context, args []string, logf logger.Logf) {
var sig os.Signal
select {
case sig = <-interrupt:
logf("BabysitProc: got signal: %v\n", sig)
logf("BabysitProc: got signal: %v", sig)
close(done)
case <-ctx.Done():
logf("BabysitProc: context done\n")
logf("BabysitProc: context done")
sig = os.Kill
close(done)
}
@@ -234,7 +233,7 @@ func BabysitProc(ctx context.Context, args []string, logf logger.Logf) {
for {
startTime := time.Now()
log.Printf("exec: %#v %v\n", executable, args)
log.Printf("exec: %#v %v", executable, args)
cmd := exec.Command(executable, args...)
// Create a pipe object to use as the subproc's stdin.
@@ -245,7 +244,7 @@ func BabysitProc(ctx context.Context, args []string, logf logger.Logf) {
// We never need to actually write to wStdin.
rStdin, wStdin, err := os.Pipe()
if err != nil {
log.Printf("os.Pipe 1: %v\n", err)
log.Printf("os.Pipe 1: %v", err)
return
}
@@ -257,7 +256,7 @@ func BabysitProc(ctx context.Context, args []string, logf logger.Logf) {
// logf() calls. bufio is more appropriate.
rStdout, wStdout, err := os.Pipe()
if err != nil {
log.Printf("os.Pipe 2: %v\n", err)
log.Printf("os.Pipe 2: %v", err)
}
go func(r *os.File) {
defer r.Close()
@@ -265,7 +264,7 @@ func BabysitProc(ctx context.Context, args []string, logf logger.Logf) {
for {
s, err := rb.ReadString('\n')
if s != "" {
logf("%s\n", strings.TrimSuffix(s, "\n"))
logf("%s", s)
}
if err != nil {
break
+28 -28
View File
@@ -76,7 +76,7 @@ func NewLocalBackend(logf logger.Logf, logid string, store StateStore, e wgengin
ctx, cancel := context.WithCancel(context.Background())
portpoll, err := portlist.NewPoller()
if err != nil {
logf("skipping portlist: %s\n", err)
logf("skipping portlist: %s", err)
}
b := &LocalBackend{
@@ -165,9 +165,9 @@ func (b *LocalBackend) Start(opts Options) error {
}
if opts.Prefs != nil {
b.logf("Start: %v\n", opts.Prefs.Pretty())
b.logf("Start: %v", opts.Prefs.Pretty())
} else {
b.logf("Start\n")
b.logf("Start")
}
hi := controlclient.NewHostinfo()
@@ -268,7 +268,7 @@ func (b *LocalBackend) Start(opts Options) error {
if strings.TrimSpace(diff) == "" {
b.logf("netmap diff: (none)")
} else {
b.logf("netmap diff:\n%v\n", diff)
b.logf("netmap diff:\n%v", diff)
}
}
b.netMapCache = newSt.NetMap
@@ -278,7 +278,7 @@ func (b *LocalBackend) Start(opts Options) error {
b.updateFilter(newSt.NetMap)
}
if newSt.URL != "" {
b.logf("Received auth URL: %.20v...\n", newSt.URL)
b.logf("Received auth URL: %.20v...", newSt.URL)
b.mu.Lock()
interact := b.interact
@@ -313,7 +313,7 @@ func (b *LocalBackend) Start(opts Options) error {
return
}
if s == nil {
log.Fatalf("weird: non-error wgengine update with status=nil\n")
log.Fatalf("weird: non-error wgengine update with status=nil")
}
es := b.parseWgStatus(s)
@@ -343,7 +343,7 @@ func (b *LocalBackend) Start(opts Options) error {
b.mu.Unlock()
blid := b.backendLogID
b.logf("Backend: logs: be:%v fe:%v\n", blid, opts.FrontendLogID)
b.logf("Backend: logs: be:%v fe:%v", blid, opts.FrontendLogID)
b.send(Notify{BackendLogID: &blid})
b.send(Notify{Prefs: prefs})
@@ -362,10 +362,10 @@ func (b *LocalBackend) updateFilter(netMap *controlclient.NetworkMap) {
// TODO(apenwarr): print a diff instead of full filter.
now := time.Now()
if now.Sub(b.lastFilterPrint) > 1*time.Minute {
b.logf("netmap packet filter: %v\n", b.netMapCache.PacketFilter)
b.logf("netmap packet filter: %v", b.netMapCache.PacketFilter)
b.lastFilterPrint = now
} else {
b.logf("netmap packet filter: (suppressed)\n")
b.logf("netmap packet filter: (suppressed)")
}
b.e.SetFilter(filter.New(netMap.PacketFilter, b.e.GetFilter()))
}
@@ -426,7 +426,7 @@ func (b *LocalBackend) popBrowserAuthNow() {
b.authURL = ""
b.mu.Unlock()
b.logf("popBrowserAuthNow: url=%v\n", url != "")
b.logf("popBrowserAuthNow: url=%v", url != "")
b.blockEngineUpdates(true)
b.stopEngineAndWait()
@@ -515,7 +515,7 @@ func (b *LocalBackend) StartLoginInteractive() {
url := b.authURL
c := b.c
b.mu.Unlock()
b.logf("StartLoginInteractive: url=%v\n", url != "")
b.logf("StartLoginInteractive: url=%v", url != "")
if url != "" {
b.popBrowserAuthNow()
@@ -525,7 +525,7 @@ func (b *LocalBackend) StartLoginInteractive() {
}
func (b *LocalBackend) FakeExpireAfter(x time.Duration) {
b.logf("FakeExpireAfter: %v\n", x)
b.logf("FakeExpireAfter: %v", x)
if b.netMapCache != nil {
e := b.netMapCache.Expiry
if e.IsZero() || time.Until(e) > x {
@@ -568,7 +568,7 @@ func (b *LocalBackend) parseWgStatus(s *wgengine.Status) EngineStatus {
rx += p.RxBytes
tx += p.TxBytes
}
b.logf("v%v peers: %v\n", version.LONG, strings.Join(ss, " "))
b.logf("v%v peers: %v", version.LONG, strings.Join(ss, " "))
return EngineStatus{
RBytes: rx,
WBytes: tx,
@@ -610,7 +610,7 @@ func (b *LocalBackend) SetPrefs(new *Prefs) {
cli := b.c
b.mu.Unlock()
b.logf("SetPrefs: %v\n", new.Pretty())
b.logf("SetPrefs: %v", new.Pretty())
if cli != nil && !oldHi.Equal(newHi) {
cli.SetHostinfo(newHi)
@@ -632,7 +632,7 @@ func (b *LocalBackend) NetMap() *controlclient.NetworkMap {
func (b *LocalBackend) blockEngineUpdates(block bool) {
// TODO(apenwarr): probably need mutex here (and several other places)
b.logf("blockEngineUpdates(%v)\n", block)
b.logf("blockEngineUpdates(%v)", block)
b.mu.Lock()
b.blocked = block
@@ -647,15 +647,15 @@ func (b *LocalBackend) authReconfig() {
b.mu.Unlock()
if blocked {
b.logf("authReconfig: blocked, skipping.\n")
b.logf("authReconfig: blocked, skipping.")
return
}
if nm == nil {
b.logf("authReconfig: netmap not yet valid. Skipping.\n")
b.logf("authReconfig: netmap not yet valid. Skipping.")
return
}
if !uc.WantRunning {
b.logf("authReconfig: skipping because !WantRunning.\n")
b.logf("authReconfig: skipping because !WantRunning.")
return
}
@@ -683,14 +683,14 @@ func (b *LocalBackend) authReconfig() {
}
cfg, err := nm.WGCfg(uflags, dns)
if err != nil {
log.Fatalf("WGCfg: %v\n", err)
log.Fatalf("WGCfg: %v", err)
}
err = b.e.Reconfig(cfg, dom)
if err == wgengine.ErrNoChanges {
return
}
b.logf("authReconfig: ra=%v dns=%v 0x%02x: %v\n", uc.RouteAll, uc.CorpDNS, uflags, err)
b.logf("authReconfig: ra=%v dns=%v 0x%02x: %v", uc.RouteAll, uc.CorpDNS, uflags, err)
}
func (b *LocalBackend) enterState(newState State) {
@@ -703,7 +703,7 @@ func (b *LocalBackend) enterState(newState State) {
if state == newState {
return
}
b.logf("Switching ipn state %v -> %v (WantRunning=%v)\n",
b.logf("Switching ipn state %v -> %v (WantRunning=%v)",
state, newState, prefs.WantRunning)
if notify != nil {
b.send(Notify{State: &newState})
@@ -717,7 +717,7 @@ func (b *LocalBackend) enterState(newState State) {
case Stopped:
err := b.e.Reconfig(&wgcfg.Config{}, nil)
if err != nil {
b.logf("Reconfig(down): %v\n", err)
b.logf("Reconfig(down): %v", err)
}
case Starting, NeedsMachineAuth:
b.authReconfig()
@@ -726,7 +726,7 @@ func (b *LocalBackend) enterState(newState State) {
case Running:
break
default:
b.logf("Weird: unknown newState %#v\n", newState)
b.logf("[unexpected] unknown newState %#v", newState)
}
}
@@ -790,22 +790,22 @@ func (b *LocalBackend) stateMachine() {
}
func (b *LocalBackend) stopEngineAndWait() {
b.logf("stopEngineAndWait...\n")
b.logf("stopEngineAndWait...")
b.e.Reconfig(&wgcfg.Config{}, nil)
b.requestEngineStatusAndWait()
b.logf("stopEngineAndWait: done.\n")
b.logf("stopEngineAndWait: done.")
}
// Requests the wgengine status, and does not return until the status
// was delivered (to the usual callback).
func (b *LocalBackend) requestEngineStatusAndWait() {
b.logf("requestEngineStatusAndWait\n")
b.logf("requestEngineStatusAndWait")
b.statusLock.Lock()
go b.e.RequestStatus()
b.logf("requestEngineStatusAndWait: waiting...\n")
b.logf("requestEngineStatusAndWait: waiting...")
b.statusChanged.Wait() // temporarily releases lock while waiting
b.logf("requestEngineStatusAndWait: got status update.\n")
b.logf("requestEngineStatusAndWait: got status update.")
b.statusLock.Unlock()
}
+4 -4
View File
@@ -66,7 +66,7 @@ func (bs *BackendServer) send(n Notify) {
n.Version = version.LONG
b, err := json.Marshal(n)
if err != nil {
log.Fatalf("Failed json.Marshal(notify): %v\n%#v\n", err, n)
log.Fatalf("Failed json.Marshal(notify): %v\n%#v", err, n)
}
bs.sendNotifyMsg(b)
}
@@ -83,9 +83,9 @@ func (bs *BackendServer) GotCommandMsg(b []byte) error {
func (bs *BackendServer) GotCommand(cmd *Command) error {
if cmd.Version != version.LONG {
vs := fmt.Sprintf("Version mismatch! frontend=%#v backend=%#v\n",
vs := fmt.Sprintf("Version mismatch! frontend=%#v backend=%#v",
cmd.Version, version.LONG)
bs.logf("%s\n", vs)
bs.logf("%s", vs)
// ignore the command, but send a message back to the
// caller so it can realize the version mismatch too.
// We don't want to exit because it might cause a crash
@@ -154,7 +154,7 @@ func (bc *BackendClient) GotNotifyMsg(b []byte) {
if n.Version != version.LONG {
vs := fmt.Sprintf("Version mismatch! frontend=%#v backend=%#v",
version.LONG, n.Version)
bc.logf("%s\n", vs)
bc.logf("%s", vs)
// delete anything in the notification except the version,
// to prevent incorrect operation.
n = Notify{