Add a driver for aw_rsb/aw_p2wi
Details
Diff Detail
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 13825 Build 14038: arc lint + arc unit
Event Timeline
share/man/man4/aw_rsb.4 | ||
---|---|---|
35 | Nd is a one-line description, so you can't wrap onto the next one. | |
43 | Start a new line for new sentences, please. | |
48 | The space before ":" is only needed on a line being interpreted in macro context, which this line is not -- you can just write "strings:". | |
50 | IIRC mandoc -Tlint will complain about .Pp before .Bl, but don't hold me to that. | |
54 | The "body text" of the item can be on the same line as the .It macro. | |
59 | .Re closes a .Rs block, which does not seem present (so the .Re can be removed) |
share/man/man4/aw_rsb.4 | ||
---|---|---|
43 | This give weird result for having two spaces between the dot and the first character. |
share/man/man4/aw_rsb.4 | ||
---|---|---|
35 | I think that having "on some Allwinner SoCs." on the next line will be problematic; mdoc(7) has: The Nd macro technically accepts child macros and terminates with a subsequent Sh invocation. Do not assume this behaviour: some whatis(1) database generators are not smart enough to parse more than the line arguments and will display macros verbatim. So, I might go with ".Nd driver for the Reduced Serial Bus/Push-Pull Two Wire Interface" (all on one line) and maybe not mention the Allwinner SoCs in this stanza. | |
43 | I am not sure I understand your reply, but yes, things render differently with 1 vs. 2 spaces after a period; this is why our style guide says to always start a new line instead of picking 1 or 2 spaces. | |
48 | I guess that's a judgment call (I prefer "strings:"). I am not 100% sure if we have a definitive style/policy on this one. | |
50 | Sure; it's not harmful and could be rolled into a hypothetical future cleanup sweep if needed. | |
54 | My apologies, the .It syntax depends on the list type. |
share/man/man4/aw_rsb.4 | ||
---|---|---|
43 | It's one of those strange French things: https://french.stackexchange.com/questions/8871/usage-of-spacing-between-punctuation-marks Manu, since the Project language is English, please adhere to its rules. I'm sorry, but space before the colon in this case is wrong. |
Just one nit, inline; otherwise this looks good.
share/man/man4/aw_rsb.4 | ||
---|---|---|
35 | The .Nd should not be on a line by itself; the "driver for ..." stuff should be on the same line, too. |
share/man/man4/aw_rsb.4 | ||
---|---|---|
29 | We usually spell out the month, so January. |
share/man/man4/aw_rsb.4 | ||
---|---|---|
36 | Is this correct? The man page is for aw_rsb, but to include the device it is just rsb? |