Re: [Xen-devel] [PATCH DOCDAY] hcall: markup the event channel hypercalls to improve generated docs

[Ian Campbell <Ian.Campbell@xxxxxxxxxx>]

On Tue, 2012-02-28 at 12:39 +0000, Ian Jackson wrote:
> Ian Campbell writes ("Re: [Xen-devel] [PATCH DOCDAY] hcall: markup the event 
> channel hypercalls to improve generated docs"):
> > Actually, the intro from that chapter is interesting/useful and I missed
> > it. Here's a new version with it included.
> ...
> > hcall: markup the event channel hypercalls to improve generated docs
> 
> Good stuff.
> 
> Acked-by: Ian Jackson <ian.jackson@xxxxxxxxxxxxx>

Thanks.

> 
> Also, as requested:
> 
> commit 78ed3b5816ed60e7e86810c2d93069fae63dc406
> Author: Ian Jackson <ian.jackson@xxxxxxxxxxxxx>
> Date:   Tue Feb 28 12:36:15 2012 +0000
> 
>     docs: xen-headers: Annotate typedefs
>     
>     Parse (some) typedef statements.  (Make type names links to the
>     underlying struct if there is one, rather than to just the typedef.)
>     
>     Also, exclude the new arch-arm headers.
>     
>     Signed-off-by: Ian Jackson <Ian.Jackson@xxxxxxxxxxxxx>

Thanks, I didn't review closely or try it yet but this jumped out at me
(twice):

> + if ($name eq 'buf_ioreq_t') {
> +     print STDERR "REFHREF $type $name | $ttype $tname | @deref\n";
> + }

And this has a odd looking indentation:

> @@ -259,6 +290,14 @@ sub process_file ($$) {
>                   in_enum($1,(ucfirst $2),$3);
>               }
>           }
> +     } elsif (s/^(typedef \s+ )((struct|union|enum) \  (\w+))
> +                      (\s+) (\w+)(\;)$
> +                  / norm($1).norm($2).$5.
> +                    defn($6,'Typedef',$6,undef,[(ucfirst $3),$4]).
> +                    $7 /xe) {
> +        } elsif (s/^(typedef \s+) (\w+) (\s+) (\w+) (\;)$

Extra leading space or a sneaky hard tab?

Ian.



_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel