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.
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
chore: Fix typos throughout codebase #15338
base: master
Are you sure you want to change the base?
Conversation
Thanks so much for the pull request! |
Hi,
Please don't mess with the checklist. We do need that checked and accurate. Also as the bot said, please do sign the CLA and let us know when you do. Thanks |
I am sorry. |
Submitted 🍏 |
!signed-cla
No worries! |
!signed-cla |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @szepeviktor for your contribution and effort! Please do not change TOML tags as this will break compatibility to existing configurations, something we don't want to do. You should rather deprecate the misspelled config setting and add a new one (just like what is done in the "binary" parser)...
APICompatability bool `toml:"api_compatability"` | ||
APICompatibility bool `toml:"api_compatibility"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We cannot do this change as this breaks existing configs! Please deprecate the old option and add a new one...
return "Celcius" | ||
return "Celsius" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We cannot do this unfortunately as this will break existing queries because the metric changes...
"tcmalloc_pageheap_committed_bytes": "TCMallocPageheapComittedBytes", | ||
"tcmalloc_pageheap_committed_bytes": "TCMallocPageheapCommittedBytes", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmmm are we sure that the type is not in the output of MongoDB stats? Otherwise this will break the plugin...
plugins/inputs/mongodb/mongostat.go
Outdated
TCMallocPageheapComittedBytes int64 | ||
TCMallocPageheapCommittedBytes int64 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here...
ServerDiagnotics bool `toml:"server_diagnotics"` | ||
ServerDiagnostics bool `toml:"server_diagnostics"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will break existing configs. Please deprecate the old option and add a new one...
plugins/inputs/ping/ping_windows.go
Outdated
@@ -114,7 +114,7 @@ func processPingOutput(out string) (statistics, error) { | |||
statsLine = stat.FindStringSubmatch(line) | |||
} | |||
if statsLine != nil && aproxs == nil { | |||
aproxs = aprox.FindStringSubmatch(line) | |||
aproxs = approx.FindStringSubmatch(line) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The array variable is also wrong, isn't it?
plugins/parsers/binary/parser.go
Outdated
Endianess string `toml:"endianess" deprecated:"1.27.4;use 'endianness' instead"` | ||
Endianness string `toml:"endianness" deprecated:"1.27.4;use 'endianness' instead"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No! Actually this is to not break configs (i.e. what you should do for the other breaking config changes above), please leave this as-is!
plugins/parsers/binary/parser.go
Outdated
if p.Endianess != "" && p.Endianness == "" { | ||
p.Endianness = p.Endianess | ||
if p.Endianness != "" && p.Endianness == "" { | ||
p.Endianness = p.Endianness |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here. This is to be compatible with old configs!
@srebhan I am sorry. Reverting manually takes hours. Now I am starting over again based on your comments. |
For the willing contributor: [files]
extend-exclude = [
".git/",
"go.mod",
"go.sum",
"CHANGELOG.md",
"**/testcases/**",
"**/testdata/**",
"plugins/inputs/zfs/README.md",
]
ignore-hidden = false
[default]
extend-ignore-re = [
"logical-ANDed",
"\\$ecret-Passw0rd",
]
[default.extend-words]
"aproxs" = "approxs"
"aer" = "aer"
"bck" = "bck"
"iif" = "iif"
"oif" = "oif"
"pn" = "pn"
"rto" = "rto"
"siz" = "siz"
"wrk" = "wrk"
"endianess" = "endianess"
"mosquitto" = "mosquitto"
"splitted" = "splitted"
# Known typos
"celcius" = "celcius"
"compatability" = "compatability"
"diagnotics" = "diagnotics"
"uncorrect" = "uncorrect"
[default.extend-identifiers]
"TLS_RSA_WITH_3DES_EDE_CBC_SHA" = "TLS_RSA_WITH_3DES_EDE_CBC_SHA"
"TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA" = "TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA"
"Ip6InECT0Pkts" = "Ip6InECT0Pkts"
"Ip6InECT1Pkts" = "Ip6InECT1Pkts"
"icmpInParmProbs" = "icmpInParmProbs"
"IcmpInParmProbs" = "IcmpInParmProbs"
"icmpOutParmProbs" = "icmpOutParmProbs"
"IcmpOutParmProbs" = "IcmpOutParmProbs"
"idel_per_s" = "idel_per_s"
"network_idel_per_s" = "network_idel_per_s"
# Known typos
"TCMallocPageheapComittedBytes" = "TCMallocPageheapComittedBytes"
# Typos
##"Github" = "GitHub" |
@szepeviktor why do you start over and why does it take hours? You just need to fix the few places I commented!?!? |
@powersj maybe we could use the software mentioned to add a GitHub action for checking spelling? |
Typos fixes typos. To revert a fix I have to search for each occurrence. |
@szepeviktor you could manually correct the few occurrences in the git branch. No need to rerun the tool... Am I missing something? |
The thing is typos work on the filesystem, not on git index. I've already redone everything. |
@szepeviktor let me be clear. You do have the present git-branch leading to this PR... Now why can't you fire-up an editor with the branch checked out and manually revert the changes in the files I mentioned without running typos again? I don't see why this is a lot of work, it's just opening an editor and changing eight lines back to what they were before!?!?!? |
When I work with typos the most of work is done by typos. |
Summary
Found few misspellings.
Checklist
Please be gentle with me, I've gone through 500k lines.