This adds basic documentation on what the superio driver is and how other
drivers can interact with it. I decided to also document superio's ivar
accessors.
Details
Details
- Reviewers
imp jhb brueffer - Group Reviewers
manpages - Commits
- rS353432: add superio.4 and superio.9 manual pages
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
| share/man/man4/superio.4 | ||
|---|---|---|
| 4 ↗ | (On Diff #63080) | This can go. |
| 107 ↗ | (On Diff #63080) | This can be removed, it does nothing here. mandoc -Tlint manpage.4 catches problems like this. |
| share/man/man9/superio.9 | ||
| 115 ↗ | (On Diff #63080) | missing space, "dev ," |
| 122 ↗ | (On Diff #63080) | Missing space, "SUPERIO_DEV_WDT ." |
| 126 ↗ | (On Diff #63080) | Missing space before "." |
| 149 ↗ | (On Diff #63080) | Missing space before "." |
| 183 ↗ | (On Diff #63080) | .Pp does nothing here and should be removed. |
| 187 ↗ | (On Diff #63080) | Trailing comma should be removed |
Comment Actions
Hmm, I see that superio.9 could become a first conditionally installed manual page in man9.
Is that okay?
Or would it be better to merge superio.9 into superio.4?
I see a couple of examples in man4, e.g., cpufreq.4.
| share/man/man9/superio.9 | ||
|---|---|---|
| 93 ↗ | (On Diff #63114) | the vendor? |
| 102 ↗ | (On Diff #63114) | the device ID? |
| 107 ↗ | (On Diff #63114) | the revision ID? |
| 159 ↗ | (On Diff #63114) | the DMA channel number? |
| 164 ↗ | (On Diff #63114) | the base I/O port? |
| 171 ↗ | (On Diff #63114) | the interrupt number? |
| 176 ↗ | (On Diff #63114) | the Logical Device Number? |
| 181 ↗ | (On Diff #63114) | the type? |
Comment Actions
@yuripv , I noted that you ended your suggestions with question marks...
I am not a native speaker, so I am not sure if definite or indefinite article is more appropriate in those sentences.