Commit 82801d06 authored Aug 30, 2016 by Mauro Carvalho Chehab Committed by Jonathan Corbet Sep 01, 2016

docs-rst: kernel-doc: fix typedef output in RST format



When using a typedef function like this one:
	typedef bool v4l2_check_dv_timings_fnc (const struct v4l2_dv_timings * t, void * handle);

The Sphinx C domain expects it to create a c:type: reference,
as that's the way it creates the type references when parsing
a c:function:: declaration.

So, a declaration like:

	.. c:function:: bool v4l2_valid_dv_timings (const struct v4l2_dv_timings * t, const struct v4l2_dv_timings_cap * cap, v4l2_check_dv_timings_fnc fnc, void * fnc_handle)

Will create a cross reference for :c:type:`v4l2_check_dv_timings_fnc`.

So, when outputting such typedefs in RST format, we need to handle
this special case, as otherwise it will produce those warnings:

	./include/media/v4l2-dv-timings.h:43: WARNING: c:type reference target not found: v4l2_check_dv_timings_fnc
	./include/media/v4l2-dv-timings.h:60: WARNING: c:type reference target not found: v4l2_check_dv_timings_fnc
	./include/media/v4l2-dv-timings.h:81: WARNING: c:type reference target not found: v4l2_check_dv_timings_fnc

So, change the kernel-doc script to produce a RST output for the
above typedef as:
	.. c:type:: v4l2_check_dv_timings_fnc

	   **Typedef**: timings check callback

	**Syntax**

	  ``bool v4l2_check_dv_timings_fnc (const struct v4l2_dv_timings * t, void * handle);``

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

parent d37c43ce

scripts/kernel-doc

+24 −10

Original line number	Diff line number	Diff line
		@@ -1831,13 +1831,22 @@ sub output_function_rst(%) {
		my %args = %{$_[0]};
		my ($parameter, $section);
		my $oldprefix = $lineprefix;
		my $start;
		my $start = "";

		if ($args{'typedef'}) {
		print ".. c:type:: ". $args{'function'} . "\n\n";
		print_lineno($declaration_start_line);
		print " Typedef: ";
		$lineprefix = "";
		output_highlight_rst($args{'purpose'});
		$start = "\n\nSyntax\n\n ``";
		} else {
		print ".. c:function:: ";
		}
		if ($args{'functiontype'} ne "") {
		$start = $args{'functiontype'} . " " . $args{'function'} . " (";
		$start .= $args{'functiontype'} . " " . $args{'function'} . " (";
		} else {
		$start = $args{'function'} . " (";
		$start .= $args{'function'} . " (";
		}
		print $start;

		@@ -1856,11 +1865,15 @@ sub output_function_rst(%) {
		print $type . " " . $parameter;
		}
		}
		if ($args{'typedef'}) {
		print ");``\n\n";
		} else {
		print ")\n\n";
		print_lineno($declaration_start_line);
		$lineprefix = " ";
		output_highlight_rst($args{'purpose'});
		print "\n";
		}

		print "Parameters\n\n";
		$lineprefix = " ";
		@@ -2203,6 +2216,7 @@ sub dump_typedef($$) {
		output_declaration($declaration_name,
		'function',
		{'function' => $declaration_name,
		'typedef' => 1,
		'module' => $modulename,
		'functiontype' => $return_type,
		'parameterlist' => \@parameterlist,

Admin message