Changeset View
Standalone View
share/man/man4/aw_rsb.4
- This file was added.
.\"- | |||||
.\" Copyright (c) 2017 Emmanuel Vadot <manu@freebsd.org> | |||||
.\" All rights reserved. | |||||
.\" | |||||
.\" Redistribution and use in source and binary forms, with or without | |||||
.\" modification, are permitted provided that the following conditions | |||||
.\" are met: | |||||
.\" 1. Redistributions of source code must retain the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer. | |||||
.\" 2. Redistributions in binary form must reproduce the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer in the | |||||
.\" documentation and/or other materials provided with the distribution. | |||||
.\" | |||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||
.\" SUCH DAMAGE. | |||||
.\" | |||||
.\" $FreeBSD$ | |||||
.\" | |||||
.Dd Dec 25, 2017 | |||||
.Dt AW_RSB 4 | |||||
brueffer: We usually spell out the month, so January. | |||||
.Os | |||||
.Sh NAME | |||||
.Nm aw_rsb | |||||
.Nd | |||||
driver for the Reduced Serial Bus/Push-Pull Two Wire Interface | |||||
.Sh SYNOPSIS | |||||
Done Inline ActionsNd is a one-line description, so you can't wrap onto the next one. bjk: Nd is a one-line description, so you can't wrap onto the next one. | |||||
Done Inline ActionsWhat do you mean ? can you provide an example please ? manu: What do you mean ? can you provide an example please ? | |||||
Done Inline ActionsI 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. bjk: I think that having "on some Allwinner SoCs." on the next line will be problematic; mdoc(7) has… | |||||
Done Inline ActionsThe .Nd should not be on a line by itself; the "driver for ..." stuff should be on the same line, too. bjk: The .Nd should not be on a line by itself; the "driver for ..." stuff should be on the same… | |||||
.Cd "device rsb" | |||||
Not Done Inline ActionsIs this correct? The man page is for aw_rsb, but to include the device it is just rsb? wblock: Is this correct? The man page is for //aw_rsb//, but to include the device it is just //rsb//? | |||||
.Cd "device p2wi" | |||||
.Sh DESCRIPTION | |||||
The | |||||
.Nm | |||||
device driver provides support for either the RSB or P2WI interface present | |||||
on Allwinner SoCs. | |||||
RSB/P2WI is an interface close to i2c developed and used by Allwinner. | |||||
Done Inline ActionsStart a new line for new sentences, please. bjk: Start a new line for new sentences, please. | |||||
Done Inline ActionsThis give weird result for having two spaces between the dot and the first character. manu: This give weird result for having two spaces between the dot and the first character. | |||||
Done Inline ActionsI 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. bjk: I am not sure I understand your reply, but yes, things render differently with 1 vs. 2 spaces… | |||||
Done Inline ActionsIt'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. danfe: It's one of those strange French things: https://french.stackexchange.com/questions/8871/usage… | |||||
.Sh HARDWARE | |||||
Done Inline Actionss/close to/similar to/ wblock: s/close to/similar to/ | |||||
The current version of the | |||||
.Nm | |||||
driver supports SoCs with one of the following compatible strings: | |||||
.Pp | |||||
Done Inline ActionsThe space before ":" is only needed on a line being interpreted in macro context, which this line is not -- you can just write "strings:". bjk: The space before ":" is only needed on a line being interpreted in macro context, which this… | |||||
Done Inline Actionsbut 'strings :' is prettier that 'strings:' no ? manu: but 'strings :' is prettier that 'strings:' no ? | |||||
Done Inline ActionsI guess that's a judgment call (I prefer "strings:"). I am not 100% sure if we have a definitive style/policy on this one. bjk: I guess that's a judgment call (I prefer "strings:"). I am not 100% sure if we have a… | |||||
Done Inline Actionss/the following/these/ (Also: in English, we do not put whitespace before a colon.) wblock: s/the following/these/
(Also: in English, we do not put whitespace before a colon.) | |||||
.Bl -bullet -compact | |||||
.It | |||||
Done Inline ActionsIIRC mandoc -Tlint will complain about .Pp before .Bl, but don't hold me to that. bjk: IIRC mandoc -Tlint will complain about .Pp before .Bl, but don't hold me to that. | |||||
Done Inline ActionsI've just take samples from other manpages. manu: I've just take samples from other manpages. | |||||
Done Inline ActionsSure; it's not harmful and could be rolled into a hypothetical future cleanup sweep if needed. bjk: Sure; it's not harmful and could be rolled into a hypothetical future cleanup sweep if needed. | |||||
allwinner,sun6i-a31-p2wi | |||||
.It | |||||
allwinner,sun8i-a23-rsb | |||||
.El | |||||
Done Inline ActionsThe "body text" of the item can be on the same line as the .It macro. bjk: The "body text" of the item can be on the same line as the .It macro. | |||||
Done Inline ActionsText doesn't render this way for me. manu: Text doesn't render this way for me. | |||||
Done Inline ActionsMy apologies, the .It syntax depends on the list type. bjk: My apologies, the .It syntax depends on the list type. | |||||
.Sh SEE ALSO | |||||
.Xr fdt 4 , | |||||
.Xr iicbus 4 , | |||||
.Xr mmc 4 | |||||
.Sh HISTORY | |||||
Done Inline Actions.Re closes a .Rs block, which does not seem present (so the .Re can be removed) bjk: .Re closes a .Rs block, which does not seem present (so the .Re can be removed) | |||||
Done Inline ActionsProbably a bad copy/paste. manu: Probably a bad copy/paste. | |||||
The | |||||
.Nm | |||||
device driver first appeared in | |||||
.Fx 11.0 . | |||||
.Sh AUTHORS | |||||
The | |||||
.Nm | |||||
device driver was written by | |||||
.An Jared McNeill Aq Mt jmcneill@invisible.ca . | |||||
This manual page was written by | |||||
.An Emmanuel Vadot Aq Mt manu@freebsd.org . |
We usually spell out the month, so January.