This repository has been archived by the owner on Sep 9, 2020. It is now read-only.
log.Logger api changes #1617
Merged
log.Logger api changes #1617
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gps: -PruneProject: remove unused logger -WriteDepTree: swap logger for onWrite callback -fix example dep: -SafeWriter.Write: nilable logger cmd: -ensure/prune/init: react to changes
jmank88
commented
Feb 2, 2018
| msg := "Wrote" | ||
| if err != nil { | ||
| msg = "Failed to write" | ||
| if onWrite != nil { |
There was a problem hiding this comment.
No more locking to serialize to ioutil.Discard
jmank88
commented
Feb 2, 2018
| func WriteDepTree(basedir string, l Lock, sm SourceManager, co CascadingPruneOptions, logger *log.Logger) error { | ||
| // | ||
| // If onWrite is not nil, it will be called after each project write. Calls are ordered and atomic. | ||
| func WriteDepTree(basedir string, l Lock, sm SourceManager, co CascadingPruneOptions, onWrite func(WriteProgress)) error { |
There was a problem hiding this comment.
Rather than log or nothing, callers get a rich type they can inspect and which also knows how to log itself.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this do / why do we need it?
This PR proposes making some exported API surrounding logging more flexible. The effect is simpler caller code (e.g.
nilrather thandiscardLogger), and completely removing some "log" imports from gps.gps:
dep:
cmd:
Do you need help or clarification on anything?
Is there a better name for
gps.WriteProgress?Which issue(s) does this PR fix?
Towards #672.