aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2013-05-28 21:52:33 +0200
committerStefano Sabatini <stefasab@gmail.com>2013-12-06 10:40:38 +0100
commit5b073da7a11f0cdcf173c4da98299ed9743e62a3 (patch)
tree1f96f326090db280b0458577857e7a811b5f5892 /doc
parent5cda499d6607050c70f90315845ceb1cec4266bd (diff)
downloadffmpeg-5b073da7a11f0cdcf173c4da98299ed9743e62a3.tar.gz
doc: add script to compute texi files dependencies
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.
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile2
-rw-r--r--doc/texidep.pl32
2 files changed, 33 insertions, 1 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 1a7c460e29..26bd9f59cb 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 0000000000..099690378e
--- /dev/null
+++ b/doc/texidep.pl
@@ -0,0 +1,32 @@
+#! /usr/bin/env perl
+
+# This script will print the dependency of a Texinfo file to stdout.
+# texidep.pl <src-path> <input.texi> <output.ext>
+
+use warnings;
+use strict;
+
+die unless @ARGV == 3;
+
+my ($src_path, $root, $target) = @ARGV;
+
+sub print_deps {
+ my ($file, $deps) = @_;
+ $deps->{$file} = 1;
+
+ open(my $fh, "<", "$file") or die "Cannot open file '$file': $!";
+ while (<$fh>) {
+ 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 source tree
+ if ("$1" ne "config.texi") {
+ print_deps("$src_path/doc/$1", {%$deps});
+ }
+ }
+ }
+}
+
+print_deps($root, {});