[FFmpeg-devel] [PATCH] doc: add script to compute texi files dependencies

[Nicolas George]

Le quintidi 15 frimaire, an CCXXII, Stefano Sabatini a écrit :
> Replace the inline awk script with a Perl script which tracks the
> dependencies recursively.
> 
> This allows to correctly track dependencies for files including files
> with a second level include (for example: ffmpeg-devices.texi ->
> devices.texi -> outdevs.texi).
> 
> This also adds a dependency on perl for computing the dependencies, which
> should not be a problem since perl is already required all the way for
> building documentation.
> 
> This is a variant of commit 628ceac6526724d35cb390cc1f88344f4ea22eb4
> which was reverted due to out-of-tree build failure.
> ---
>  configure      |  4 ++--
>  doc/Makefile   |  2 +-

>  doc/texidep.pl | 25 +++++++++++++++++++++++++

From _Programming Perl_:

# Note that using a .pl extension means you can no longer tell the
# difference between an executable Perl program and a "perl library" file.
# You could use .plx for a Perl program instead to avoid this. This is less
# of an issue these days, as Perl modules live in .pm files, and people
# don't write as many .pl files.


>  3 files changed, 28 insertions(+), 3 deletions(-)
>  create mode 100644 doc/texidep.pl
> 
> diff --git a/configure b/configure
> index 5881e6a..fb063e6 100755
> --- a/configure
> +++ b/configure
> @@ -2335,8 +2335,8 @@ ffserver_extralibs='$ldl'
>  # documentation
>  podpages_deps="perl"
>  manpages_deps="perl pod2man"
> -htmlpages_deps="texi2html"
> -txtpages_deps="makeinfo"
> +htmlpages_deps="perl texi2html"
> +txtpages_deps="perl makeinfo"
>  doc_deps_any="manpages htmlpages podpages txtpages"
>  
>  # default parameters
> diff --git a/doc/Makefile b/doc/Makefile
> index 1a7c460..26bd9f5 100644
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -61,7 +61,7 @@ documentation: $(DOCS)
>  
>  examples: $(DOC_EXAMPLES)
>  
> -TEXIDEP = awk '/^@(verbatim)?include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
> +TEXIDEP = perl $(SRC_PATH)/doc/texidep.pl $(SRC_PATH) $< $@ >$(@:%=%.d)
>  
>  doc/%.txt: TAG = TXT
>  doc/%.txt: doc/%.texi
> diff --git a/doc/texidep.pl b/doc/texidep.pl
> new file mode 100644
> index 0000000..c014882
> --- /dev/null
> +++ b/doc/texidep.pl
> @@ -0,0 +1,25 @@
> +#! /usr/bin/perl
> +
> +use warnings;
> +use strict;
> +

> +my ($src_path, $root, $target) = @ARGV;

die unless @ARGV == 3;

> +
> +sub print_deps {

I suggest a prototype, for safety.

> +    my ($file, $deps) = @_;
> +    $deps->{$file} = 1;
> +

> +    open(my $fh, "$file") or die "Cannot open file '$file': $!";

open(my $fh, "<", $file)

although it probably does not matter much in this particular case.

> +    while (<$fh>) {

> +        /^@(?:verbatim)?include\s+(\S+)/ and do {

Counting on $1 in several lines is fragile: an extra line with a regexp can
break it. I suggest:

	if (my ($i) = /^\@(?:verbatim)?include\s+(\S+)/) {

> +            die "Circular dependency found in file $root\n" if exists $deps->{"doc/$1"};
> +            print "$target: doc/$1\n";
> +            # skip looking for config.texi dependencies, since it has none, and is not located in the build tree
> +            if ("$1" ne "config.texi") {
> +                print_deps("$src_path/doc/$1", {%$deps});
> +            }
> +        }
> +    }
> +}
> +
> +print_deps($root, {});

Should be ok, these are very minor remarks.

Regards,

-- 
  Nicolas George
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20131205/2f5c0af3/attachment.asc>