doc: add script to compute texi files dependencies
authorStefano Sabatini <stefasab@gmail.com>
Tue, 28 May 2013 19:52:33 +0000 (21:52 +0200)
committerStefano Sabatini <stefasab@gmail.com>
Wed, 3 Jul 2013 09:25:45 +0000 (11:25 +0200)
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.

configure
doc/Makefile
doc/texidep.pl [new file with mode: 0644]

index dd6e951..97f6913 100755 (executable)
--- a/configure
+++ b/configure
@@ -2214,8 +2214,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
index cd24b8c..ab18146 100644 (file)
@@ -43,7 +43,7 @@ doc: documentation
 apidoc: doc/doxy/html
 documentation: $(DOCS)
 
-TEXIDEP = awk '/^@(verbatim)?include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
+TEXIDEP = perl $(SRC_PATH)/doc/texidep.pl $< $@ >$(@:%=%.d)
 
 doc/%.txt: TAG = TXT
 doc/%.txt: doc/%.texi
diff --git a/doc/texidep.pl b/doc/texidep.pl
new file mode 100644 (file)
index 0000000..0275e74
--- /dev/null
@@ -0,0 +1,22 @@
+#! /usr/bin/perl
+
+use warnings;
+use strict;
+
+my ($root, $target) = @ARGV;
+
+sub print_deps {
+    my ($file, $deps) = @_;
+    $deps->{$file} = 1;
+
+    open(my $fh, "$file") or die "Cannot open file '$file': $!";
+    while (<$fh>) {
+        /^@(?:verbatim)?include\s+(\S+)/ and do {
+            die "Circular dependency found in file $root\n" if exists $deps->{"doc/$1"};
+            print "$target: doc/$1\n";
+            print_deps("doc/$1", {%$deps});
+        }
+    }
+}
+
+print_deps($root, {});