Em Fri, 28 Oct 2016 16:20:24 +0200
Borislav Petkov <[email protected]> escreveu:
> On Wed, Oct 26, 2016 at 05:58:54PM -0200, Mauro Carvalho Chehab wrote:
> > Several functions are documented at edac_mc.c.
> >
> > As we'll be including edac_core.h at drivers-api book, move
> > those, in order for the kernel-doc markups be part of the API
> > documentation book.
>
> So what is the story now?
>
> All EDAC documentation needs to go into edac_core.h now?
>
> I don't like having one fat EDAC header containing all documentation
> glue. Can it be split?
IMHO, it is cleaner to have the documentation at the headers, instead
of mixing it with code. Also, if we add documentation on both,
We'll need to specify both the header and the C files at the
kernel-doc include directives.
That's said, I agree that the edac_core.h is now too big.
It probably makes sense to follow the same logic used by the
edac *.c files, e. g. split it into:
drivers/edac/edac_device.h
drivers/edac/edac_mc.h
drivers/edac/edac_pci.h
or even into:
drivers/edac/edac_device.h
drivers/edac/edac_device_sysfs.h
drivers/edac/edac_mc.h
drivers/edac/edac_mc_sysfs.h
drivers/edac/edac_pci.h
drivers/edac/edac_pci_sysfs.h
drivers/edac/edac_stub.h
Thanks,
Mauro
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
