From: Ondrej Zajicek (work) <santiago@crfreenet.org>
Date: Fri, 14 Dec 2018 00:53:32 +0000 (+0100)
Subject: Doc: Move root of code documentation to doc dir
X-Git-Tag: v2.0.3~17
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1e0fccd1af54fdd4dbd79f6e7c5715478f83dea3;p=thirdparty%2Fbird.git

Doc: Move root of code documentation to doc dir

It reduces clutter in root and also avoid collision with doc dir on
case-insensitive filesystems when name back to Doc.
---

diff --git a/progdoc b/doc/prog-root
similarity index 80%
rename from progdoc
rename to doc/prog-root
index 770613904..c31e5ae18 100644
--- a/progdoc
+++ b/doc/prog-root
@@ -1,5 +1,5 @@
 D doc/prog-head.sgml
-C doc
+D doc/prog-intro.sgml
 C nest
 C conf
 C filter
diff --git a/doc/progdoc b/doc/progdoc
deleted file mode 100644
index 0c3e04e56..000000000
--- a/doc/progdoc
+++ /dev/null
@@ -1 +0,0 @@
-D prog-intro.sgml
diff --git a/tools/progdoc b/tools/progdoc
index 9b27d14e8..32e9771eb 100755
--- a/tools/progdoc
+++ b/tools/progdoc
@@ -4,7 +4,7 @@ $srcdir = $ARGV[0];
 $out = $ARGV[1];
 
 open(OUT, ">", $out) || die "Cannot create output file";
-process($srcdir);
+process($srcdir, "doc/prog-root");
 close OUT;
 gen_deps();
 exit 0;
@@ -21,9 +21,10 @@ sub include {
 
 sub process {
   my $dir = shift @_;
-  print "$dir/progdoc\n";
-  open(IN, "$dir/progdoc") || die "Unable to read $dir/progdoc";
-  push(@deps, "$dir/progdoc");
+  my $doc = "$dir/" . shift @_;
+  print "$doc\n";
+  open(IN, $doc) || die "Unable to read $doc";
+  push(@deps, $doc);
   my @docfile = <IN>;
   close IN;
   foreach $_ (@docfile) {
@@ -32,7 +33,7 @@ sub process {
     /^([A-Z]+)\s*(.*)/ || die "Parse error: $_";
     $cmd = $1;
     $arg = $2;
-    if ($cmd eq "C") { process("$dir/$arg"); }
+    if ($cmd eq "C") { process("$dir/$arg", "progdoc"); }
     elsif ($cmd eq "H") {
       push @stack, "H";
       print OUT "<chapt>$arg\n";