-
Notifications
You must be signed in to change notification settings - Fork 2k
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
tests/periph_flashpage: small cleanup #8770
Conversation
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.
Just have some suggestions. Otherwise I agree the help strings needed a bit more detail.
tests/periph_flashpage/main.c
Outdated
@@ -283,8 +283,8 @@ static const shell_command_t shell_commands[] = { | |||
{ "info", "Show information about pages", cmd_info }, | |||
{ "dump", "Dump the selected page to STDOUT", cmd_dump }, | |||
{ "dump_local", "Dump the local page buffer to STDOUT", cmd_dump_local }, | |||
{ "read", "Read and output the given page", cmd_read }, | |||
{ "write", "Write (ASCII) data to the given page", cmd_write }, | |||
{ "read", "Copy the given page to the local page and dump to STDOUT", cmd_read }, |
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.
I'd say there's no local "page" but ram "buffer"... I suggest:
Load the given page into RAM and dump it to STDOUT
.
tests/periph_flashpage/main.c
Outdated
{ "read", "Read and output the given page", cmd_read }, | ||
{ "write", "Write (ASCII) data to the given page", cmd_write }, | ||
{ "read", "Copy the given page to the local page and dump to STDOUT", cmd_read }, | ||
{ "write", "Write the local page buffer to the given page", cmd_write }, |
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.
Here I'd say ASCII is important. I suggest:
Write (ASCII) data from RAM buffer into the given page
9d4425f
to
c5aba69
Compare
@kYc0o, I changed slightly my first approach and used |
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.
ACK. Newline prints message on non working write.
Using locale page buffer
matches the edit
command so its good for me.
@kYc0o, do you ACK ? |
tests/periph_flashpage/README.md
Outdated
@@ -34,5 +34,5 @@ What else to check: | |||
|
|||
Background | |||
========== | |||
This test provides you with tools to test implementations of the `flashpage` | |||
peripheral driver interface. | |||
This test provides tools to test implementations of the `flashpage` peripheral |
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.
test ... to test
Seems somewhat redundant. :-)
What about "This shell provides commands to test ...."?
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.
Not exactly your suggestion, but I just pushed an update of this.
c5aba69
to
890cec3
Compare
@kYc0o, just missing your ACK here |
ACK. |
Contribution description
This PR makes some cleanup in the
tests/periph_flashpage
application. While working on #8768, I had trouble with some misleading outputs/command help.Issues/PRs references
None