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.
This commit is contained in:
Martin Mares 2000-05-05 17:15:56 +00:00
parent c7d7794bb9
commit b177724896
5 changed files with 26 additions and 24 deletions

2
TODO
View file

@ -14,6 +14,8 @@ Core
- configure: --enable-ipv6 - configure: --enable-ipv6
- configure: IPv6 on glibc 2.0? - configure: IPv6 on glibc 2.0?
- Makefile: install target?
- forgetting device routes??? - forgetting device routes???
- kernel syncer doesn't support reconfiguration - kernel syncer doesn't support reconfiguration
- filter-defined internal attributes - filter-defined internal attributes

View file

@ -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 userdocs:
# bird.html
clean:
rm *.html *.tex *.dvi *.log
%.html: %.sgml %.html: %.sgml
./sgml2html $< ./sgml2html $<
dnl INFO format:
%.info: %.sgml %.info: %.sgml
sgml2info $< sgml2info $<
dnl TXT format:
%.txt: %.sgml %.txt: %.sgml
sgml2txt $< sgml2txt $<
dnl LATEX format:
%.dvi: %.sgml %.dvi: %.sgml
./sgml2latex $< ./sgml2latex $<
%.tex: %.sgml %.tex: %.sgml
./sgml2latex --output=tex $< ./sgml2latex --output=tex $<
internals.html: ../filter/filter.c ../proto/rip/rip.c clean:
kernel-doc -html ../filter/filter.c ../proto/rip/rip.c > internals.html rm *.html *.tex *.dvi *.log

View file

@ -1,9 +1,9 @@
# Makefile for in place build of BIRD # Makefile for in place build of BIRD
# (c) 1999 Martin Mares <mj@ucw.cz> # (c) 1999--2000 Martin Mares <mj@ucw.cz>
objdir=@objdir@ objdir=@objdir@
all depend tags: all depend tags docs userdocs progdocs:
$(MAKE) -C $(objdir) $@ $(MAKE) -C $(objdir) $@
clean: clean:

View file

@ -3,9 +3,7 @@
include Rules include Rules
srcdir_abs := $(shell cd $(srcdir) ; pwd) .PHONY: all daemon client subdir depend clean distclean tags docs userdocs progdocs
.PHONY: all daemon client subdir depend clean distclean tags
all: .dep-stamp subdir daemon @CLIENT@ all: .dep-stamp subdir daemon @CLIENT@
@ -24,18 +22,23 @@ $(exedir)/birdc: client/all.o lib/birdlib.a
$(CC) $(LDFLAGS) -o $@ $^ $(LIBS) $(CLIENT_LIBS) $(CC) $(LDFLAGS) -o $@ $^ $(LIBS) $(CLIENT_LIBS)
.dir-stamp: .dir-stamp:
mkdir -p $(static-dirs) $(client-dirs) mkdir -p $(static-dirs) $(client-dirs) $(doc-dirs)
touch .dir-stamp touch .dir-stamp
.dep-stamp: .dep-stamp:
$(MAKE) depend $(MAKE) depend
touch .dep-stamp touch .dep-stamp
docs: userdocs progdocs
userdocs progdocs: .dir-stamp
$(MAKE) -C doc -f $(srcdir_abs)/doc/Makefile $@
tags: tags:
cd $(srcdir) ; etags -lc `find $(static-dirs) $(addprefix $(objdir)/,$(dynamic-dirs)) $(client-dirs) -name *.[chY]` cd $(srcdir) ; etags -lc `find $(static-dirs) $(addprefix $(objdir)/,$(dynamic-dirs)) $(client-dirs) -name *.[chY]`
clean: 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 rm -f $(exedir)/bird $(exedir)/birdc $(exedir)/bird.ctl .dep-stamp
distclean: clean distclean: clean

View file

@ -1,7 +1,8 @@
# Makefile fragments for the BIRD Internet Routing Daemon # 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=@srcdir_rel_mf@
srcdir_abs := $(shell cd $(srcdir) ; pwd)
objdir=@objdir@ objdir=@objdir@
exedir=@exedir@ exedir=@exedir@
@ -12,8 +13,10 @@ dynamic-dirs := lib conf
dynamic-dir-paths := $(dynamic-dirs) dynamic-dir-paths := $(dynamic-dirs)
client-dirs := @CLIENT@ client-dirs := @CLIENT@
client-dir-paths := $(client-dirs) 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 clean-dirs:=$(all-dirs) proto sysdep
CPPFLAGS=-I$(root-rel) -I$(srcdir) @CPPFLAGS@ CPPFLAGS=-I$(root-rel) -I$(srcdir) @CPPFLAGS@