Fix missing newline in sysfs file kxo_state #21
Merged
Conversation
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
jserv
requested changes
Apr 29, 2025
Contributor
jserv
left a comment
jserv
left a comment
There was a problem hiding this comment.
It is not necessary to mention the kernel module in the git commit message as "kxo" already indicates which kernel module is being referenced. Instead, the message should emphasize how you diagnosed and resolved the unintended truncation issue.
When using cat command to read /sys/class/kxo/kxo/kxo_state file, the output (e.g., "1 1 0") did not include a newline, causing the terminal prompt to appear on the same line (e.g., "1 1 0user@Ubuntu:~$"). This truncation issue is diagnosed by examining kxo_state_show, which uses snprintf with a format string "%c %c %c\n". The size parameter of snprintf set to 6 included the null terminator \0 as the last character, leaving only 5 bytes for the desired output (e.g., "1 0 0\n"), thus the newline symbol \n was truncated by null terminator. This commit resolves the issue by increasing the size parameter of snprintf from 6 to 7, ensuring the output includes the newline.
JeepWay
force-pushed
the
show-missing-newline
branch
from
9390568 to
2829628
Compare
JeepWay
changed the title
Contributor
Author
@jserv I have updated the original commit message to emphasize the diagnosis and resolving process. |
Contributor
|
Thank @JeepWay for contributing! |
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.
When reading
/sys/class/kxo/kxo/kxo_stateusingcat, the output lacked a newline, causing the terminal prompt to appear on the same line (e.g.,1 1 0user@Ubuntu:~$).The issue was diagnosed by analyzing
kxo_state_show: thesnprintffunction was called with a size parameter of 6, which includes the null terminator (\0). This left only 5 bytes for the output (e.g.,1 0 0\n), truncating the newline character (\n). Thus,kxo_state_showoutputs1 0 0\0, not1 0 0\n\0.This patch fixes the issue by increasing the size parameter of
snprintffrom 6 to 7, ensuring the output includes the newline.hachmd record