Hi,
this is a RFC as I'm not quite sure if this change has some subtle side
effect.
Commit 654784284430 ("kernel-doc: bugfix - multi-line macros") introduces
pre-processing of backslashes at the end of a line to not break multi-line
macros. This pre-processing is done independently if it is inside code or
inside a comment.
This illustation of a hierarchy as a code block inside a kernel-doc comment
has a backslash at the end of the line:
---8<---
/**
* DOC: hierarchy
*
* Top Level
* / \
* Child A Child B
*/
---8<---
It will be displayed as:
---8<---
Top Level
/ * Child A Child B
---8<---
As I asked for a solution on the linux-doc mailing list, I got some
suggestions with workarounds and also got the suggestion by Matthew Wilcox
to adapt the backslash preprocessing in kernel-doc script. I tested it and
fixed then the newly produced warnings which are covered in the first
patch. The processing of the documentation seems to work - but please don't
rely only on my tests as I'm not a perl neither a kernel-doc expert.
Thanks,
Anna-Maria
Anna-Maria Behnsen (2):
drm/vram-helper: Fix 'multi-line' kernel-doc comments
scripts/kernel-doc: Do not process backslash lines in comments
drivers/gpu/drm/drm_gem_vram_helper.c | 44 ++++++++++++---------------
include/drm/drm_gem_vram_helper.h | 16 +++++-----
scripts/kernel-doc | 2 +-
3 files changed, 29 insertions(+), 33 deletions(-)
--
2.39.2
