Skip to content
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

Merged
merged 1 commit into from
Mar 16, 2018

Conversation

aabadie
Copy link
Contributor

@aabadie aabadie commented Mar 13, 2018

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

@aabadie aabadie added Area: tests Area: tests and testing framework Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Mar 13, 2018
@kYc0o kYc0o self-assigned this Mar 13, 2018
Copy link
Contributor

@kYc0o kYc0o left a 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.

@@ -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 },
Copy link
Contributor

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.

{ "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 },
Copy link
Contributor

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

@aabadie aabadie force-pushed the pr/tests/flashpage branch from 9d4425f to c5aba69 Compare March 14, 2018 18:59
@aabadie
Copy link
Contributor Author

aabadie commented Mar 14, 2018

@kYc0o, I changed slightly my first approach and used local page buffer instead of local page. Buffer is already used in other places. Is it fine for you ?

Copy link
Contributor

@cladmi cladmi left a 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.

@aabadie
Copy link
Contributor Author

aabadie commented Mar 15, 2018

@kYc0o, do you ACK ?

@@ -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
Copy link
Member

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 ...."?

Copy link
Contributor Author

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.

@aabadie aabadie force-pushed the pr/tests/flashpage branch from c5aba69 to 890cec3 Compare March 16, 2018 14:21
@aabadie
Copy link
Contributor Author

aabadie commented Mar 16, 2018

@kYc0o, just missing your ACK here

@kYc0o
Copy link
Contributor

kYc0o commented Mar 16, 2018

ACK.

@kYc0o kYc0o merged commit 81875fc into RIOT-OS:master Mar 16, 2018
@aabadie aabadie deleted the pr/tests/flashpage branch March 21, 2018 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: tests Area: tests and testing framework CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants