summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Mares <mj@ucw.cz>2000-05-05 17:15:56 +0000
committerMartin Mares <mj@ucw.cz>2000-05-05 17:15:56 +0000
commitb177724896b75159dbc8e203ac0e5a134229ae90 (patch)
tree4ff62df2354b09aad3fea8e420c6b8d35e0dc70f
parentc7d7794bb9a71be58d06c6c9ea67943d3e33a566 (diff)
Connected the `doc' subtree to global makefiles.
All documentation is built in obj/doc (resp. doc/ if you do a stand-alone build). Use `make docs' to make the whole documentation or `make userdocs' resp. `make progdocs' for user manual resp. developer's guide.
-rw-r--r--TODO2
-rw-r--r--doc/Makefile24
-rw-r--r--tools/Makefile-top.in4
-rw-r--r--tools/Makefile.in13
-rw-r--r--tools/Rules.in7
5 files changed, 26 insertions, 24 deletions
diff --git a/TODO b/TODO
index 108f1321..7f478f27 100644
--- a/TODO
+++ b/TODO
@@ -14,6 +14,8 @@ Core
- configure: --enable-ipv6
- configure: IPv6 on glibc 2.0?
+- Makefile: install target?
+
- forgetting device routes???
- kernel syncer doesn't support reconfiguration
- filter-defined internal attributes
diff --git a/doc/Makefile b/doc/Makefile
index fe263be5..f16de99a 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,34 +1,28 @@
-# Makefile for bird documentation system
+root-rel=../
+dir-name=doc
+include ../Rules
-SHELL = /bin/sh
+progdocs:
+ mkdir -p prog
+ $(srcdir)/tools/progdoc $(srcdir_abs)
-all: internals.html
-# bird.html
-
-clean:
- rm *.html *.tex *.dvi *.log
+userdocs:
%.html: %.sgml
./sgml2html $<
-dnl INFO format:
-
%.info: %.sgml
sgml2info $<
-dnl TXT format:
-
%.txt: %.sgml
sgml2txt $<
-dnl LATEX format:
-
%.dvi: %.sgml
./sgml2latex $<
%.tex: %.sgml
./sgml2latex --output=tex $<
-internals.html: ../filter/filter.c ../proto/rip/rip.c
- kernel-doc -html ../filter/filter.c ../proto/rip/rip.c > internals.html
+clean:
+ rm *.html *.tex *.dvi *.log
diff --git a/tools/Makefile-top.in b/tools/Makefile-top.in
index 0dee0dc7..415bc876 100644
--- a/tools/Makefile-top.in
+++ b/tools/Makefile-top.in
@@ -1,9 +1,9 @@
# Makefile for in place build of BIRD
-# (c) 1999 Martin Mares <mj@ucw.cz>
+# (c) 1999--2000 Martin Mares <mj@ucw.cz>
objdir=@objdir@
-all depend tags:
+all depend tags docs userdocs progdocs:
$(MAKE) -C $(objdir) $@
clean:
diff --git a/tools/Makefile.in b/tools/Makefile.in
index 1dcb9bce..5eb71835 100644
--- a/tools/Makefile.in
+++ b/tools/Makefile.in
@@ -3,9 +3,7 @@
include Rules
-srcdir_abs := $(shell cd $(srcdir) ; pwd)
-
-.PHONY: all daemon client subdir depend clean distclean tags
+.PHONY: all daemon client subdir depend clean distclean tags docs userdocs progdocs
all: .dep-stamp subdir daemon @CLIENT@
@@ -24,18 +22,23 @@ $(exedir)/birdc: client/all.o lib/birdlib.a
$(CC) $(LDFLAGS) -o $@ $^ $(LIBS) $(CLIENT_LIBS)
.dir-stamp:
- mkdir -p $(static-dirs) $(client-dirs)
+ mkdir -p $(static-dirs) $(client-dirs) $(doc-dirs)
touch .dir-stamp
.dep-stamp:
$(MAKE) depend
touch .dep-stamp
+docs: userdocs progdocs
+
+userdocs progdocs: .dir-stamp
+ $(MAKE) -C doc -f $(srcdir_abs)/doc/Makefile $@
+
tags:
cd $(srcdir) ; etags -lc `find $(static-dirs) $(addprefix $(objdir)/,$(dynamic-dirs)) $(client-dirs) -name *.[chY]`
clean:
- find . -name "*.[oa]" -or -name core -or -name depend | xargs rm -f
+ find . -name "*.[oa]" -o -name core -o -name depend -o -name "*.html" | xargs rm -f
rm -f $(exedir)/bird $(exedir)/birdc $(exedir)/bird.ctl .dep-stamp
distclean: clean
diff --git a/tools/Rules.in b/tools/Rules.in
index a10f76fd..6e786266 100644
--- a/tools/Rules.in
+++ b/tools/Rules.in
@@ -1,7 +1,8 @@
# Makefile fragments for the BIRD Internet Routing Daemon
-# (c) 1999 Martin Mares <mj@ucw.cz>
+# (c) 1999--2000 Martin Mares <mj@ucw.cz>
srcdir=@srcdir_rel_mf@
+srcdir_abs := $(shell cd $(srcdir) ; pwd)
objdir=@objdir@
exedir=@exedir@
@@ -12,8 +13,10 @@ dynamic-dirs := lib conf
dynamic-dir-paths := $(dynamic-dirs)
client-dirs := @CLIENT@
client-dir-paths := $(client-dirs)
+doc-dirs := doc
+doc-dir-paths := $(doc-dirs)
-all-dirs:=$(static-dirs) $(dynamic-dirs) $(client-dirs)
+all-dirs:=$(static-dirs) $(dynamic-dirs) $(client-dirs) $(doc-dirs)
clean-dirs:=$(all-dirs) proto sysdep
CPPFLAGS=-I$(root-rel) -I$(srcdir) @CPPFLAGS@