Re: [Ksummit-discuss] [TECH TOPIC] Documentation

Julia Lawall
2020-06-13T16:43:00Z

I tried collecting information about missing or incorrectly formatted
function documentation using Coccinelle. Here is an example of the
output:

drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr: extra names mod, f_isr, h_src_arg
drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr: missing name isr_cb
drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr: missing name module
drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr: missing name src_arg
drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr: return comment but no return value
drivers/net/ethernet/freescale/fman/fman.c:2103 fman_unregister_intr: extra names mod
drivers/net/ethernet/freescale/fman/fman.c:2103 fman_unregister_intr: missing name module
drivers/net/ethernet/freescale/fman/fman.c:2103 fman_unregister_intr: return comment but no return value
drivers/net/ethernet/freescale/fman/fman.c:2355 fman_get_revision: return comment but no return value
drivers/net/ethernet/freescale/fman/fman.c:2520 fman_bind: extra names dev
drivers/net/ethernet/freescale/fman/fman.c:2520 fman_bind: missing name fm_dev
drivers/net/ethernet/freescale/fman/fman.c:2527 fman_has_errata_a050385: no comment for fman_has_errata_a050385

It's not illustrated here, but if it can find documentation for the same
variable with the same type somewhere else in the same file, it suggests
that, and it finds a mention of the function in the Documentation
directory, it give the name of that file.

I assumed that all EXPORT_SYMBOLs and EXPORT_SYMBOL_GPLs should be
documented. Perhaps this was an overapproximation, because it seems like
a lot of them are not.

julia