Page MenuHomeFreeBSD
Differential D31122

nvmecontrol: document power command
ClosedPublic
Actions

Authored by imp on Jul 9 2021, 6:12 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mar 22 2024, 10:31 PM
Unknown Object (File)
Mar 22 2024, 10:31 PM
Unknown Object (File)
Mar 22 2024, 10:31 PM
Unknown Object (File)
Mar 22 2024, 10:31 PM
Unknown Object (File)
Mar 22 2024, 10:31 PM
Unknown Object (File)
Mar 22 2024, 10:31 PM
Unknown Object (File)
Mar 9 2024, 11:58 AM
Unknown Object (File)
Feb 14 2024, 4:36 AM
View All 36 Files
Subscribers
dab

Details

Reviewers
phk
chuck
mav
Group Reviewers
manpages
Commits
rG4905e7273229: nvmecontrol: document power command
rG39d7a1f47909: nvmecontrol: document power command
rG445b5554bf97: nvmecontrol: document power command
Summary

The description of the power command is missing. While the synopsis is present,
there's no explanation. Add one.

PR: 237866
Sponsored by: Netflix

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

imp created this revision.Jul 9 2021, 6:12 PM
Herald added a reviewer: manpages. · View Herald TranscriptJul 9 2021, 6:12 PM
Herald added a subscriber: dab. · View Herald Transcript
imp requested review of this revision.Jul 9 2021, 6:12 PM
Harbormaster completed remote builds in B40416: Diff 92023.Jul 9 2021, 6:12 PM
imp edited the summary of this revision. (Show Details)Jul 9 2021, 6:13 PM
imp added reviewers: phk, chuck, mav.
mav accepted this revision.Jul 9 2021, 6:24 PM

I haven't used the power setting myself, but it looks mostly good for me.

sbin/nvmecontrol/nvmecontrol.8
500

I think here should be specified standard version, otherwise section number makes no sense.

This revision is now accepted and ready to land.Jul 9 2021, 6:24 PM
chuck added inline comments.Jul 9 2021, 6:36 PM
sbin/nvmecontrol/nvmecontrol.8
500

In the 2.0 specification, this is section 8.15.3, and this functionality doesn't exist prior to the 1.2 version.

I don't feel strongly about how to change this, but some suggestions are:

  • Keep the section name but drop the number
  • Drop this sentence
  • Drop this sentence and modify the opening of the section to something like

Set the NVM Subsystem Workload hint for automatic power mode control.

501

Subsystem misspelled

chuck accepted this revision.Jul 9 2021, 6:37 PM
imp marked an inline comment as done.Jul 9 2021, 7:46 PM
imp added inline comments.
sbin/nvmecontrol/nvmecontrol.8
500

Tweaked the wording. It was the same in 1.2 and 1.4 so I thought it would be safe. I used

Please see the "NVM Subsystem Workloads" section of the relevant NVM Express standard for details.

which feels better. The standard is long, so we should refer to some sub-part of it.

imp updated this revision to Diff 92025.Jul 9 2021, 7:48 PM

Review comments addressed, will commit later today if no objections.

This revision now requires review to proceed.Jul 9 2021, 7:48 PM
Harbormaster completed remote builds in B40417: Diff 92025.Jul 9 2021, 7:48 PM
mav accepted this revision.Jul 9 2021, 7:50 PM
This revision is now accepted and ready to land.Jul 9 2021, 7:50 PM
imp updated this revision to Diff 92026.Jul 9 2021, 7:55 PM

A little more word smithing. Will hold off til Monday committing.

This revision now requires review to proceed.Jul 9 2021, 7:55 PM
Harbormaster completed remote builds in B40418: Diff 92026.Jul 9 2021, 7:55 PM
chuck added inline comments.Jul 9 2021, 8:28 PM
sbin/nvmecontrol/nvmecontrol.8
477

Extra words here. Maybe

List all power modes the controller supports.

501

This sounds good to me

imp updated this revision to Diff 92027.Jul 9 2021, 8:36 PM

tweak chuck suggested.

Harbormaster completed remote builds in B40419: Diff 92027.Jul 9 2021, 8:36 PM
chuck accepted this revision.Jul 9 2021, 8:57 PM

LGTM

This revision is now accepted and ready to land.Jul 9 2021, 8:57 PM
Closed by commit rG445b5554bf97: nvmecontrol: document power command (authored by imp). · Explain WhyJul 10 2021, 4:54 PM
This revision was automatically updated to reflect the committed changes.
imp added a commit: rG445b5554bf97: nvmecontrol: document power command.
imp added a commit: rG39d7a1f47909: nvmecontrol: document power command.Jul 12 2021, 7:44 PM
imp added a commit: rG4905e7273229: nvmecontrol: document power command.Jul 31 2021, 5:07 AM

Revision Contents
Changeset List

PathSize
sbin/
nvmecontrol/
33 lines

Diff 92050

View Options

sbin/nvmecontrol/nvmecontrol.8

Loading...