| Message ID | 1441129454-10356-1-git-send-email-danilo.cesar@collabora.co.uk (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Tue, 1 Sep 2015 14:44:14 -0300 Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk> wrote: > Docproc process EXPORT_SYMBOL(f1) macro and uses -nofunc f1 to > avoid duplicated documentation in the next call. > It works for most of the cases, but there are some specific situations > where a struct has the same name of an already-exported function. > > Current kernel-doc behavior ignores those structs and do not add them > to the final documentation. This patch fixes it. > > This is non-usual and the only case I've found is the drm_modeset_lock > (function and struct) defined in drm_modeset_lock.h and > drm_modeset_lock.c. Considering this, it should only affect the DRM > documentation by including struct drm_modeset_lock to the final Docbook. I've verified that it indeed affects nothing else; it's in the docs tree now, thanks. jon
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 12a106c..047deb7 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -1827,7 +1827,7 @@ sub output_declaration { my $func = "output_${functype}_$output_mode"; if (($function_only==0) || ( $function_only == 1 && defined($function_table{$name})) || - ( $function_only == 2 && !defined($function_table{$name}))) + ( $function_only == 2 && !($functype eq "function" && defined($function_table{$name})))) { &$func(@_); $section_counter++;
Docproc process EXPORT_SYMBOL(f1) macro and uses -nofunc f1 to avoid duplicated documentation in the next call. It works for most of the cases, but there are some specific situations where a struct has the same name of an already-exported function. Current kernel-doc behavior ignores those structs and do not add them to the final documentation. This patch fixes it. This is non-usual and the only case I've found is the drm_modeset_lock (function and struct) defined in drm_modeset_lock.h and drm_modeset_lock.c. Considering this, it should only affect the DRM documentation by including struct drm_modeset_lock to the final Docbook. Signed-off-by: Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk> Cc: Daniel Vetter <daniel.vetter@ffwll.ch> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Andrew Morton <akpm@linux-foundation.org> Cc: Johannes Berg <johannes.berg@intel.com> Cc: linux-kernel@vger.kernel.org Cc: linux-doc@vger.kernel.org Cc: intel-gfx <intel-gfx@lists.freedesktop.org> Cc: dri-devel <dri-devel@lists.freedesktop.org> --- scripts/kernel-doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)