Re: [PATCH] Add kerneldoc for flush_scheduled_work()

Johannes Weiner
2009-08-18T09:05:09Z

Hello Randy,

On Fri, Aug 14, 2009 at 11:23:55AM -0700, Randy Dunlap wrote:
> Johannes Weiner wrote:
> > diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> > index b52d340..2921aab 100755
> > --- a/scripts/kernel-doc
> > +++ b/scripts/kernel-doc
> > @@ -281,6 +281,7 @@ my $doc_end = '\*/';
> > my $doc_com = '\s*\*\s*';
> > my $doc_decl = $doc_com . '(\w+)';
> > my $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)';
> > +my $doc_cont = $doc_com . '([^@/\s].*)';
> > my $doc_content = $doc_com . '(.*)';
> > my $doc_block = $doc_com . 'DOC:\s*(.*)?';
> >
> > @@ -1995,6 +1996,7 @@ sub process_file($) {
> > my $identifier;
> > my $func;
> > my $descr;
> > + my $in_purpose = 0;
> > my $initial_section_counter = $section_counter;
> >
> > if (defined($ENV{'SRCTREE'})) {
> > @@ -2044,6 +2046,7 @@ sub process_file($) {
> > $descr =~ s/\s*$//;
> > $descr =~ s/\s+/ /;
> > $declaration_purpose = xml_escape($descr);
> > + $in_purpose = 1;
> > } else {
> > $declaration_purpose = "";
> > }
> > @@ -2075,7 +2078,12 @@ sub process_file($) {
> > ++$warnings;
> > $state = 0;
> > }
> > + } elsif ($in_purpose == 1 && /$doc_cont/o) {
> > + # continued description
> > + chomp($declaration_purpose);
> > + $declaration_purpose .= " " . $1;
> > } elsif ($state == 2) { # look for head: lines, and include content
> > + $in_purpose = 0;
> > if (/$doc_sect/o) {
> > $newsection = $1;
> > $newcontents = $2;
>
> Hi Hannes,
>
> This looks good in theory, but it doesn't survive a "make htmldocs"
> after the patch is applied.
>
> It could be the ending kernel-doc comment characters:
> **/
>
> The problem is in drivers/scsi/scsi_devinfo.c:
> /**
> * scsi_dev_info_list_delete - called from scsi.c:exit_scsi to remove the scsi_dev_info_list.
> **/
> void scsi_exit_devinfo(void)
> {
>
>
> I'm currently on vacation, but I'll look into it more if you can't
> do so.

Yeah, it's the terminating **/ which matches $doc_cont. I will try to
send an updated version this evening.

Hannes