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

doc: show where self-test results can be found #2525

Merged
merged 1 commit into from
Oct 21, 2024

Conversation

paumr
Copy link
Contributor

@paumr paumr commented Oct 4, 2024

As a first-time user I was wondering on where to find the device-self-test results.

I think adding this information to the device-self-test documentation would be quite useful.

@igaw
Copy link
Collaborator

igaw commented Oct 4, 2024

Looks good.

Just a nit: Could you add your Signed-off-by to the commit message? Or I can add it if it's okay for you.

Thanks!

@paumr paumr force-pushed the doc_show_self-test-log branch 3 times, most recently from c6c1561 to 5bd0a54 Compare October 4, 2024 13:58
@paumr
Copy link
Contributor Author

paumr commented Oct 4, 2024

Thanks! Sure, I signed the commit - thanks for the review.

@igaw
Copy link
Collaborator

igaw commented Oct 4, 2024

We follow the Linux kernel mailing list workflow, thus commit message itself should be something like

doc: show where self-test results can be found

Point out where find results when running the self tests.

Signed-off-by: My Name/alias <email.address.foo>

Point the reader of the device-self-test documentation to
the command used for querying the test results.

Signed-off-by: paumr <[email protected]>
@paumr paumr force-pushed the doc_show_self-test-log branch from 5bd0a54 to 610dc48 Compare October 21, 2024 09:32
@paumr
Copy link
Contributor Author

paumr commented Oct 21, 2024

Done, sorry for the delay, I did not receive a notification about your most recent message.

@igaw igaw merged commit 078d068 into linux-nvme:master Oct 21, 2024
18 checks passed
@igaw
Copy link
Collaborator

igaw commented Oct 21, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants