[Qemu-devel] [PATCH v4 4/4] devicetree: update documentation for fw_cfg ARM bindings
Gabriel L. Somlo
somlo at cmu.edu
Tue Nov 17 21:17:27 EST 2015
On Tue, Nov 17, 2015 at 04:14:42PM -0600, Rob Herring wrote:
> On Mon, Nov 16, 2015 at 2:38 AM, Paolo Bonzini <pbonzini at redhat.com> wrote:
> >
> >
> > On 15/11/2015 03:07, Rob Herring wrote:
> >> We generally don't want DT docs to depend on other kernel documentation.
> >
> > DT docs do not contain a copy of the data sheets, either. There is no
> > reason to say how to use the device (and even then, only doing so
> > partially) in the DT docs.
>
> The difference is datasheets apply to all OS's, kernel documentation
> does not. In theory at least this could be used for other OS's, right?
>
> Perhaps QEMU is the right place to thoroughly describe this and DT and
> sysfs docs can refer to it.
So, leave only ARM/DT specifc details in
Documentation/devicetree/bindings/arm/fw-cfg.txt,
and rework the fw_cfg sysfs patch (1/4) to only document
sysfs specific details in
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg ?
The fw_cfg "datasheet" does exist in QEMU already, so there is
something to point at from either/both of the above.
Thanks,
--Gabriel
More information about the Kernelnewbies
mailing list