Hello all,
I would like to discuss a recurring issue that we all have encountered
while running `make htmldocs`. The process often generates an overwhelming
amount of warnings that are not relevant to our work, which makes it harder
to identify and address actual warning messages related to our changes.
One of the reasons for this is the variation in warnings raised by
different compilers. For instance, the Linux kernel robot employs Sparse,
which recently raised a warning that we (Avadhut in CC, and then me
reviewing his patch) did not catch during our testing [1,2].
Particularly annoying -to me personally- are warnings of the form:
"warning: Function parameter or member 'field' not described in 'struct'"
that seem to enumerate every single undocumented field within a struct.
I would like to propose something to alleviate this issue before the list
of warnings keeps piling up. I suggest for the command `make htmldocs` to
only display, by default, warnings directly related to the changes being
made, unless explicitly requested otherwisee.
I'm thinking we could do this, for example, by making hmtldocs a two-step
process: First running htmldocs as usual but with warnings disabled, and
then generating docs again but only for the new files (see $git diff
--name-only HEAD), with warnings active but limited to the scope of the
changes made.
I'm interested in your thoughts and comments. Does anyone have a better
idea regarding this? Maybe someone more experienced in Sphinx can tell us
an alternative way to disable unrelated warnings.
Thanks,
Carlos
Signed-off-by: Carlos Bilbao <carlos.bilbao@xxxxxxx>
[1] https://lore.kernel.org/all/20230717181602.3468421-1-avadhut.naik@xxxxxxx/
[2]
https://download.01.org/0day-ci/archive/20230722/202307221642.nEBAfROh-lkp@xxxxxxxxx/reproduce
