[Feature #21133] Add skip_header option#119
Merged
hsbt merged 1 commit intoruby:masterfrom Mar 11, 2025
Merged
Conversation
jeremyevans
approved these changes
Feb 13, 2025
Contributor
jeremyevans
left a comment
jeremyevans
left a comment
There was a problem hiding this comment.
I'm not the logger maintainer, but I think this is a useful feature, and the implementation looks fine.
viralpraxis
force-pushed
the
add-skip-header-option
branch
from
561f3a2 to
7e2e9e3
Compare
viralpraxis
changed the title
skip_header optionskip_header option
ref: https://bugs.ruby-lang.org/issues/21133 Creating a logger automatically writes a hardcoded header comment ("# Logfile created on ..."). While this helps verify that logdev is writable as early as possible (rather than on the first log entry), it also serves as a useful indicator of which program created the logfile. However, this header can introduce unnecessary complexity -- especially when working with third-party tools that need to ignore these lines. This commit introduces a `skip_header` boolean option (default is `false`), allowing API consumers to disable the header if needed.
viralpraxis
force-pushed
the
add-skip-header-option
branch
from
7e2e9e3 to
552b075
Compare
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
3 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.
Creating a logger automatically writes a hardcoded header comment ("# Logfile created on ...").
While this helps verify that logdev is writable as early as possible (rather than on the first log entry), it also serves as a useful indicator of which program created the logfile.
However, this header can introduce unnecessary
complexity -- especially when working with third-party tools that need to ignore these lines.
This commit introduces a
skip_headerbooleanoption (default is
false), allowing API consumers to disable the header if needed.issue: https://bugs.ruby-lang.org/issues/21133