commands,git/githistory: pass *log.Logger in externally#2537
Merged
commands,git/githistory: pass *log.Logger in externally#2537
Conversation
technoweenie
approved these changes
Aug 30, 2017
Contributor
technoweenie
left a comment
There was a problem hiding this comment.
Agreed. I don't think accepting only an io.Writer makes sense when the rewriter is just calling log.NewLogger().
chrisd8088
added a commit
to chrisd8088/git-lfs
that referenced
this pull request
May 26, 2023
In commit 3129b9a of PR git-lfs#2537 the "githistory" package was updated so the WithLogger global option variable now required a *log.Logger argument instead of calling log.NewLogger(). This was done so the "git lfs migrate" commands could pass in a previously initialized logger to which the commands had already written log messages; that change was introduced in PR git-lfs#2538. In the same commit of PR git-lfs#2537, a WithLoggerTo global option function was added to preserve the existing behaviour. However, this option has never been utilized, and so to reduce unnecessary complexity we just remove it now. Note that the use of functional options in the Git LFS project stems from PR git-lfs#2295 and is inspired by the design proposed in several articles from 2014; see, for reference: https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis https://commandcenter.blogspot.com/2014/01/self-referential-functions-and-design.html
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This pull request allows callers of the
git/githistory.NewRewriter()function to pass in agit/githistory/log.(*Logger)that they created, instead of just supplying theio.Writersink.This allows callers to maintain a handle on the given logger without expanding the API of functions that
*HistoryRewriterreceives. Callers that hold a reference to the logger can add their own arbitrary tasks to it, while maintaining the same synchronicity guarentees that the*Loggertype provides.This is done in anticipation of the
git-lfs-migrate(1)command being able to fetch remote refs before beginning a migration. Doing so will require the migrator to log that it is fetching so it does not appear to hang, and thus requires a change like the one presented in this pull request./cc @git-lfs/core