diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-10-27 10:51:05 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2020-10-28 11:26:09 -0600 |
| commit | 72b97d0b911872ba36a5742b7d790b6b165e11d8 (patch) | |
| tree | 864478a85589dfd3cf2e9735abe480c7c839884f /scripts/kernel-doc | |
| parent | e051955977b7e26124aa8c8398278145f85f94e8 (diff) | |
| download | linux-stable-72b97d0b911872ba36a5742b7d790b6b165e11d8.tar.gz linux-stable-72b97d0b911872ba36a5742b7d790b6b165e11d8.tar.bz2 linux-stable-72b97d0b911872ba36a5742b7d790b6b165e11d8.zip | |
scripts: kernel-doc: use :c:union when needed
Sphinx C domain code after 3.2.1 will start complaning if :c:struct
would be used for an union type:
.../Documentation/gpu/drm-kms-helpers:352: ../drivers/video/hdmi.c:851: WARNING: C 'identifier' cross-reference uses wrong tag: reference name is 'union hdmi_infoframe' but found name is 'struct hdmi_infoframe'. Full reference name is 'union hdmi_infoframe'. Full found name is 'struct hdmi_infoframe'.
So, let's address this issue too in advance, in order to
avoid future issues.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/6e4ec3eec914df62389a299797a3880ae4490f35.1603791716.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/kernel-doc')
| -rwxr-xr-x | scripts/kernel-doc | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index cf71897df36d..f699cf05d409 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -1092,7 +1092,11 @@ sub output_struct_rst(%) { print "\n\n.. c:type:: " . $name . "\n\n"; } else { my $name = $args{'struct'}; - print "\n\n.. c:struct:: " . $name . "\n\n"; + if ($args{'type'} eq 'union') { + print "\n\n.. c:union:: " . $name . "\n\n"; + } else { + print "\n\n.. c:struct:: " . $name . "\n\n"; + } } print_lineno($declaration_start_line); $lineprefix = " "; |