Am 29.08.2016 um 15:13 schrieb Mauro Carvalho Chehab <[email protected]>:
> A macro definition is mapped via .. c:function:: at the
> ReST markup when using the following kernel-doc tag:
>
> /**
> * DMX_FE_ENTRY - Casts elements in the list of registered
> * front-ends from the generic type struct list_head
> * to the type * struct dmx_frontend
> *
> * @list: list of struct dmx_frontend
> */
> #define DMX_FE_ENTRY(list) \
> list_entry(list, struct dmx_frontend, connectivity_list)
>
> However, unlike a function description, the arguments of a macro
> doesn't contain the data type.
>
> This causes warnings when enabling Sphinx on nitkpick mode,
> like this one:
> ./drivers/media/dvb-core/demux.h:358: WARNING: c:type reference target
> not found: list
I think this is a drawback of sphinx's C-domain, using function
definition for macros also. From the function documentation
"""This is also used to describe function-like preprocessor
macros. The names of the arguments should be given so
they may be used in the description."""
I think about to fix the nitpick message for macros (aka function
directive) in the C-domain extension (we already have).
But for this, I need a rule to distinguish between macros
and functions ... is the uppercase of the macro name a good
rule to suppress the nitpick message? Any other suggestions?
-- Markus --
>
> That happens because kernel-doc output for the above is:
>
> .. c:function:: DMX_FE_ENTRY ( list)
>
> Casts elements in the list of registered front-ends from the generic
> type struct list_head to the type * struct dmx_frontend
>
> **Parameters**
>
> ``list``
> list of struct dmx_frontend
>
> As the type is blank, Sphinx would think that ``list`` is a type,
> and will try to add a cross reference for it, using their internal
> representation for c:type:`list`.
>
> However, ``list`` is not a type. So, that would cause either the
> above warning, or if a ``list`` type exists, it would create
> a reference to the wrong place at the doc.
>
> To avoid that, let's ommit macro arguments from c:function::
> declaration. As each argument will appear below the Parameters,
> the type of the argument can be described there, if needed.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
>
> v3: version 2 patch caused a regression when handling function arguments,
> because the counter were not incremented on all cases. Fix it.
>
> scripts/kernel-doc | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index d225e178aa1b..bac0af4fc659 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -1846,14 +1846,15 @@ sub output_function_rst(%) {
> if ($count ne 0) {
> print ", ";
> }
> - $count++;
> $type = $args{'parametertypes'}{$parameter};
>
> if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
> # pointer-to-function
> print $1 . $parameter . ") (" . $2;
> - } else {
> + $count++;
> + } elsif ($type ne "") {
> print $type . " " . $parameter;
> + $count++;
> }
> }
> print ")\n\n";
> --
> 2.7.4
>
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-media" in
> the body of a message to [email protected]
> More majordomo info at http://vger.kernel.org/majordomo-info.html
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
