Re: [Qemu-devel] [PATCH v4 02/21] maint: Allow for EXAMPLES in texi2pod

[Vladimir Sementsov-Ogievskiy]

17.01.2019 22:36, Eric Blake wrote:
> The next commit will add an EXAMPLES section to qemu-nbd.8;
> for that to work, we need to recognize EXAMPLES in texi2pod.
> We also need to add a dependency from all man pages against
> the generator script, since a change to the generator may
> cause the resulting man page to differ.
> 
> Signed-off-by: Eric Blake <address@hidden>
> Reviewed-by: Richard W.M. Jones <address@hidden>
> 
> ---
> v3: add generic dependency for all man pages in $(DOCS) instead of
> per-line editing [Vladimir]
> ---
>   Makefile            | 2 ++
>   scripts/texi2pod.pl | 2 +-
>   2 files changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/Makefile b/Makefile
> index dccba1dca27..2639437cdaf 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -858,6 +858,8 @@ docs/interop/qemu-qmp-ref.dvi 
> docs/interop/qemu-qmp-ref.html \
>       docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7: \
>       docs/interop/qemu-qmp-ref.texi docs/interop/qemu-qmp-qapi.texi
> 
> +$(filter %.1 %.7 %.8,$(DOCS)): scripts/texi2pod.pl
> +
>   # Reports/Analysis
> 
>   %/coverage-report.html:
> diff --git a/scripts/texi2pod.pl b/scripts/texi2pod.pl
> index 39ce584a322..839b7917cf7 100755
> --- a/scripts/texi2pod.pl
> +++ b/scripts/texi2pod.pl
> @@ -398,7 +398,7 @@ $sects{NAME} = "$fn \- $tl\n";
>   $sects{FOOTNOTES} .= "=back\n" if exists $sects{FOOTNOTES};
> 
>   for $sect (qw(NAME SYNOPSIS DESCRIPTION OPTIONS ENVIRONMENT FILES
> -           BUGS NOTES FOOTNOTES SEEALSO AUTHOR COPYRIGHT)) {
> +           BUGS NOTES FOOTNOTES EXAMPLES SEEALSO AUTHOR COPYRIGHT)) {
>       if(exists $sects{$sect}) {
>       $head = $sect;
>       $head =~ s/SEEALSO/SEE ALSO/;
> 

I've no idea about how texi2pod.pl works, but Makefile change looks a lot
clearer now, so I have nor more suggestions. Also, I've checked that after
this patch change to scripts/texi2pod.pl really results in remaking selected
targets :)

Reviewed-by: Vladimir Sementsov-Ogievskiy <address@hidden>

-- 
Best regards,
Vladimir