couple questions about stuff in kernel-doc-nano-HOWTO.txt

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



  first, this:

"!E<filename> is replaced by the documentation, in <filename>, for
functions that are exported using EXPORT_SYMBOL: the function list is
collected from files listed in Documentation/DocBook/Makefile."

what does the last part of that mean? what files is this referring to
that are listed in that Makefile?

  also, there doesn't seem to be a difference between "!E" and "!D",
as you can read below:

... snip ...
!E<filename> is replaced by the documentation, in <filename>, for
functions that are exported using EXPORT_SYMBOL: the function list is
collected from files listed in Documentation/DocBook/Makefile.

!I<filename> is replaced by the documentation for functions that are
_not_ exported using EXPORT_SYMBOL.

!D<filename> is used to name additional files to search for functions
exported using EXPORT_SYMBOL.
... snip ...

  anyone reading that might wonder how !E and !D differ and, in fact,
in the entirety of the .tmpl files, there is only a single example of
!D anywhere, and it's commented out (networking.tmpl):

<!-- The !D functionality is not perfect, garbage has to be protected by comments
!Dnet/sunrpc/sunrpc_syms.c
-->

and here's the code that represents the difference in docproc.c:

                                case 'E':
                                        while (*s && !isspace(*s)) s++;
                                        *s = '\0';
                                        externalfunctions(line+2);
                                        break;
                                case 'I':
                                        while (*s && !isspace(*s)) s++;
                                        *s = '\0';
                                        internalfunctions(line+2);
                                        break;
                                case 'D':
                                        while (*s && !isspace(*s)) s++;
                                        *s = '\0';
                                        symbolsonly(line+2);
                                        break;

so what's the point of "!D" if it's allegedly broken?

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux