Bug 200836 - SR-IOV support should include config option description
Summary: SR-IOV support should include config option description
Status: Open
Alias: None
Product: Base System
Classification: Unclassified
Component: kern (show other bugs)
Version: CURRENT
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-bugs (Nobody)
URL:
Keywords: needs-patch, needs-qa
Depends on:
Blocks:
 
Reported: 2015-06-13 14:51 UTC by Ravi Pokala
Modified: 2021-02-09 19:04 UTC (History)
6 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ravi Pokala 2015-06-13 14:51:38 UTC
As discussed moments ago during the SR-IOV talk at BSDCan, `iovctl' does not include descriptions for the various config options. Sometimes the options are obvious; other times, less so. They should be defined along with a description, like sysctls are. Per rstone@, this needs to be part of the SR-IOV API before the 10.2 code freeze.
Comment 1 Ravi Pokala 2015-06-23 20:27:12 UTC
rstone@ - you said you wanted to get this fix into 10.2 before the freeze - 10-STABLE is already slushed, so the window is closing...
Comment 2 Kubilay Kocak freebsd_committer freebsd_triage 2021-02-09 01:15:18 UTC
Has an option description been added since the original report here?
Comment 3 John Baldwin freebsd_committer freebsd_triage 2021-02-09 18:34:47 UTC
Ravi, can you clarify what specific options you are talking about?  If it is the set of options you can include in the config file, that is covered in iovctl.conf(5).  I'm not sure what else "config options" can refer to though.  Do you mean embedded descriptions in the returned schema reported by iovctl -S?
Comment 4 Ryan Stone freebsd_committer 2021-02-09 19:02:27 UTC
Yeah, he wants a description for every field in the config schema.  I think that it's a good thing to do; I just never got around to implementing it.
Comment 5 Ravi Pokala 2021-02-09 19:04:48 UTC
(In reply to John Baldwin from comment #3)
I have no idea what this was referring to. I have a vague recollection of rstone@'s talk, and being asked to file the bug. It's quite possible that iovctl.conf.5 didn't exist at the time, and this bug was to create it.

I'm fine closing this out as WORKSFORME.

EDIT: I see rstone@ beat me to the comment, with a better memory! :-) I defer to him WRT leaving this open or closing this out if it's just not going to get done.