From 9546653ebe1f499b035550f589fc818321e3eac1 Mon Sep 17 00:00:00 2001 From: Kern Sibbald Date: Mon, 18 Jul 2005 09:03:50 +0000 Subject: [PATCH] Make developers doc build + make distribution --- docs/Makefile | 30 +++---- docs/Makefile.in | 30 +++---- docs/README | 16 ++++ docs/autoconf/configure.in | 2 + docs/configure | 4 +- docs/developers/{Makefile => Makefile.in} | 102 +++++++++------------- docs/developers/version.tex | 2 +- docs/developers/version.tex.in | 2 +- docs/manual/Makefile.in | 34 ++++---- 9 files changed, 110 insertions(+), 112 deletions(-) rename docs/developers/{Makefile => Makefile.in} (58%) diff --git a/docs/Makefile b/docs/Makefile index 72df70af..12ad2bed 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -48,6 +48,7 @@ INSTALL_CONFIG = /usr/bin/install -c -m 640 srcdir = . .PATH: . +BACULASRC = /home/kern/bacula/k basedir = .. topdir = .. @@ -63,6 +64,8 @@ DIST = Makefile.in #------------------------------------------------------------------------- all: + (cd manual; make) + (cd developers; make developers) configure: autoconf/configure.in autoconf/aclocal.m4 autoconf/acconfig.h autoconf/config.h.in @@ -121,21 +124,16 @@ uninstall: distribution: rm -rf bacula-doc-* mkdir -p bacula-doc-$(VERSION) - cp -ap latex/bacula bacula-doc-$(VERSION)/web-manual + cp -ap manual/bacula bacula-doc-$(VERSION)/web-manual mkdir -p bacula-doc-$(VERSION)/html-manual - cp -p latex/bacula.html latex/*.png latex/*.css bacula-doc-$(VERSION)/html-manual/ - cp -p latex/bacula.pdf bacula-doc-$(VERSION)/ - cp -p latex/developers.pdf bacula-doc-$(VERSION)/ - cp -p ../kernstodo bacula-doc-$(VERSION)/ - cp -p ../ReleaseNotes bacula-doc-$(VERSION)/ - cp -p ../projects bacula-doc-$(VERSION)/ + cp -p manual/bacula.html manual/*.png manual/*.css bacula-doc-$(VERSION)/html-manual/ + cp -p manual/bacula.pdf bacula-doc-$(VERSION)/ + cp -p developers/developers.pdf bacula-doc-$(VERSION)/ + cp -p $(BACULASRC)/kernstodo bacula-doc-$(VERSION)/ + cp -p $(BACULASRC)/ReleaseNotes bacula-doc-$(VERSION)/ + cp -p $(BACULASRC)/projects bacula-doc-$(VERSION)/ tar cvfz bacula-doc-$(VERSION).tar.gz bacula-doc-$(VERSION) - -distdirs: - mkdir $(basedir)/../$(VERNAME)/$(thisdir) - -distcopy: distdepend - $(CP) -p $(basedir)/$(VERNAME).lsm $(basedir)/../$(VERNAME); - $(CP) -p $(DIST) $(basedir)/../$(VERNAME)/$(thisdir) - -distdepend: alldoc + rm -rf bacula-doc-$(VERSION) + @echo " " + @echo "Distribution document is in: bacula-doc-$(VERSION).tar.gz" + @echo " " diff --git a/docs/Makefile.in b/docs/Makefile.in index 4c73a856..ef021a32 100644 --- a/docs/Makefile.in +++ b/docs/Makefile.in @@ -6,6 +6,7 @@ srcdir = @srcdir@ VPATH = @srcdir@ .PATH: @srcdir@ +BACULASRC = @bacula@ basedir = .. topdir = .. @@ -21,6 +22,8 @@ DIST = Makefile.in #------------------------------------------------------------------------- all: + (cd manual; make) + (cd developers; make developers) configure: autoconf/configure.in autoconf/aclocal.m4 autoconf/acconfig.h autoconf/config.h.in @@ -79,21 +82,16 @@ uninstall: distribution: rm -rf bacula-doc-* mkdir -p bacula-doc-$(VERSION) - cp -ap latex/bacula bacula-doc-$(VERSION)/web-manual + cp -ap manual/bacula bacula-doc-$(VERSION)/web-manual mkdir -p bacula-doc-$(VERSION)/html-manual - cp -p latex/bacula.html latex/*.png latex/*.css bacula-doc-$(VERSION)/html-manual/ - cp -p latex/bacula.pdf bacula-doc-$(VERSION)/ - cp -p latex/developers.pdf bacula-doc-$(VERSION)/ - cp -p ../kernstodo bacula-doc-$(VERSION)/ - cp -p ../ReleaseNotes bacula-doc-$(VERSION)/ - cp -p ../projects bacula-doc-$(VERSION)/ + cp -p manual/bacula.html manual/*.png manual/*.css bacula-doc-$(VERSION)/html-manual/ + cp -p manual/bacula.pdf bacula-doc-$(VERSION)/ + cp -p developers/developers.pdf bacula-doc-$(VERSION)/ + cp -p $(BACULASRC)/kernstodo bacula-doc-$(VERSION)/ + cp -p $(BACULASRC)/ReleaseNotes bacula-doc-$(VERSION)/ + cp -p $(BACULASRC)/projects bacula-doc-$(VERSION)/ tar cvfz bacula-doc-$(VERSION).tar.gz bacula-doc-$(VERSION) - -distdirs: - mkdir $(basedir)/../$(VERNAME)/$(thisdir) - -distcopy: distdepend - $(CP) -p $(basedir)/$(VERNAME).lsm $(basedir)/../$(VERNAME); - $(CP) -p $(DIST) $(basedir)/../$(VERNAME)/$(thisdir) - -distdepend: alldoc + rm -rf bacula-doc-$(VERSION) + @echo " " + @echo "Distribution document is in: bacula-doc-$(VERSION).tar.gz" + @echo " " diff --git a/docs/README b/docs/README index f7dc6b43..a22f2672 100644 --- a/docs/README +++ b/docs/README @@ -27,7 +27,15 @@ Web site: nothing to build, simply copy the files to the Web site, then load the documents in the appropriate places. + English manual: + cd + make + + The above builds both the English Bacula document and + the developer's document. When the other languages are + ready for distribution, it will also build those languages. + cd manual make @@ -48,3 +56,11 @@ developer's manual: cd developers Same as above. +To create a distribution tar file: + cd + make + make distribution + + The output will be a .tar.gz file in the current directory + with the name bacula-doc-.tar.gz + It will print the name. diff --git a/docs/autoconf/configure.in b/docs/autoconf/configure.in index 5daed5ac..b3536ad8 100644 --- a/docs/autoconf/configure.in +++ b/docs/autoconf/configure.in @@ -96,6 +96,8 @@ AC_OUTPUT([ \ manual-de/version.tex \ manual-fr/Makefile \ manual-fr/version.tex \ + developers/Makefile \ + developers/version.tex \ $PFILES ], [ ] ) diff --git a/docs/configure b/docs/configure index ee04843f..adee2a28 100755 --- a/docs/configure +++ b/docs/configure @@ -1768,7 +1768,7 @@ MCOMMON=./autoconf/Make.common - ac_config_files="$ac_config_files autoconf/Make.common Makefile manual/Makefile manual/version.tex manual-de/Makefile manual-de/version.tex manual-fr/Makefile manual-fr/version.tex $PFILES" + ac_config_files="$ac_config_files autoconf/Make.common Makefile manual/Makefile manual/version.tex manual-de/Makefile manual-de/version.tex manual-fr/Makefile manual-fr/version.tex developers/Makefile developers/version.tex $PFILES" ac_config_commands="$ac_config_commands default" cat >confcache <<\_ACEOF # This file is a shell script that caches the results of configure @@ -2332,6 +2332,8 @@ do "manual-de/version.tex" ) CONFIG_FILES="$CONFIG_FILES manual-de/version.tex" ;; "manual-fr/Makefile" ) CONFIG_FILES="$CONFIG_FILES manual-fr/Makefile" ;; "manual-fr/version.tex" ) CONFIG_FILES="$CONFIG_FILES manual-fr/version.tex" ;; + "developers/Makefile" ) CONFIG_FILES="$CONFIG_FILES developers/Makefile" ;; + "developers/version.tex" ) CONFIG_FILES="$CONFIG_FILES developers/version.tex" ;; "$PFILES" ) CONFIG_FILES="$CONFIG_FILES $PFILES" ;; "default" ) CONFIG_COMMANDS="$CONFIG_COMMANDS default" ;; *) { { echo "$as_me:$LINENO: error: invalid argument: $ac_config_target" >&5 diff --git a/docs/developers/Makefile b/docs/developers/Makefile.in similarity index 58% rename from docs/developers/Makefile rename to docs/developers/Makefile.in index 808c14bd..4e2ab7b5 100644 --- a/docs/developers/Makefile +++ b/docs/developers/Makefile.in @@ -4,11 +4,9 @@ # # To build everything do # make tex -# make links -# make all # make web # make html -# make pdf +# make dvipdf # # or simply # @@ -17,43 +15,10 @@ IMAGES=../images -# bacula -- special case below -# running -- special case below -# developers -- special case below - -# -# Note, these are all parts of the manual not in any -# particular order (mostly alphabetic). The order they -# appear in the manual is defined in bacula.tex -# -# Note also that certain of these chapters are in the -# bacula.tex manual, and others in the developers.tex -# manual. -# -MANUAL = \ - autochangers bootstrap bugs catalog \ - catmaintenance configure consoleconf console critical \ - daemonprotocol dirdconf director disk faq filedconf file \ - firewalls gpl install internaldb kaboom lesser \ - license messagesres monitorconf mysql oldfileset pools \ - porting postgresql progs projects quickstart recycling \ - regression rescuefloppy rescue restore rpm-faq \ - security spooling sqlite state storage \ - storedconf strategies stunnel \ - requirements supportedoses supporteddrives tapetesting \ - thanks tips vars verify win32 \ - daemonprotocol gui-interface \ - supportedchangers \ - md5 mediaformat mempool netprotocol porting smartall - - -first_rule: developers +first_rule: bacula bacula: tex web html dvipdf -# Note, assume bacula manual was built first -# I've removed devhtml so that the resulting files -# (images) do not conflict with the main manual developers: devtex devweb devpdf .SUFFIXES: .tex .html @@ -87,12 +52,16 @@ pdf: @echo "Making pdfm" @cp -fp ${IMAGES}/hires/*.eps . dvipdfm -p a4 bacula.dvi +# Rename for loading on Web site + @cp -f bacula.pdf dev-bacula.pdf @rm -f *.eps *.old dvipdf: @echo "Making dvi to pdf" @cp -fp ${IMAGES}/hires/*.eps . dvipdf bacula.dvi bacula.pdf +# Rename for loading on Web site + @cp -f bacula.pdf dev-bacula.pdf @rm -f *.eps *.old @@ -103,60 +72,75 @@ devpdf: @rm -f *.eps *.old devpdfm: - @echo "Making pdfm" + @echo "Making developers pdfm" @cp -fp ${IMAGES}/hires/*.eps . dvipdfm -p a4 developers.dvi @rm -f *.eps *.old html: + @echo " " @echo "Making html" @cp -fp ${IMAGES}/*.eps . + @rm -f next.eps next.png prev.eps prev.png up.eps up.png + @(if [ -e imagename_translations ] ; then \ + ./translate_images.pl --from_meaningful_names bacula.html; \ + fi) latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \ - bacula >/dev/null - ./translate_images.pl bacula.html + -init_file latex2html-init.pl bacula >tex.out 2>&1 + ./translate_images.pl --to_meaningful_names bacula.html @rm -f *.eps *.gif *.jpg + @echo "Done making html" devhtml: @echo "Making developers html" - @./translate_images.pl --from_meaningful_names developers.html @cp -fp ${IMAGES}/*.eps . + @rm -f next.eps next.png prev.eps prev.png up.eps up.png + @(if [ -e imagename_translations ] ; then \ + ./translate_images.pl --from_meaningful_names developers.html; \ + fi) latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \ - -init_file latex2html-init.pl developers >/dev/null - @echo - @./translate_images.pl --to_meaningful_names developers.html + developers >/dev/null + ./translate_images.pl --to_meaningful_names developers.html @rm -f *.eps *.gif *.jpg *.old - web: @echo "Making web" @mkdir -p bacula - @rm -rf bacula/* @cp -fp ${IMAGES}/*.eps . @rm -f next.eps next.png prev.eps prev.png up.eps up.png @cp -fp ${IMAGES}/*.eps *.txt bacula + @cp -fp ${IMAGES}/*.eps *.txt ${IMAGES}/*.png bacula + @rm -f bacula/xp-*.png @rm -f bacula/next.eps bacula/next.png bacula/prev.eps bacula/prev.png bacula/up.eps bacula/up.png + @rm -rf bacula/*.html latex2html -split 4 -local_icons -t "Bacula User's Guide" -long_titles 4 \ - -toc_stars -contents_in_nav -white -notransparent bacula >/dev/null - ./translate_images.pl bacula/Bacula_Users_Guide.html - @cp -f bacula/Bacula_Users_Guide.html bacula/index.html - @cp -f bacula/Bacula_Freque_Asked_Questi.html bacula/faq.html - @rm -f *.eps *.gif *.jpg bacula/*.eps *.old + -toc_stars -contents_in_nav -init_file latex2html-init.pl -white -notransparent bacula >tex.out 2>&1 + ./translate_images.pl --to_meaningful_names bacula/Bacula_Users_Guide.html + cp -f bacula/Bacula_Freque_Asked_Questi.html bacula/faq.html + @rm -f *.eps *.gif *.jpg bacula/*.eps *.old bacula/*.old + @echo "Done making web" devweb: @echo "Making developers web" @mkdir -p developers - @./translate_images.pl --from_meaningful_names developers/Developers_Guide.html - @rm -f developers/*.html + @rm -f developers/* @cp -fp ${IMAGES}/*.eps . @rm -f next.eps next.png prev.eps prev.png up.eps up.png - @cp -fp ${IMAGES}/*.eps developers/ + @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png developers/ @rm -f developers/next.eps developers/next.png developers/prev.eps developers/prev.png developers/up.eps developers/up.png - latex2html -split 5 -local_icons -t "Developer's Guide" -init_file latex2html-init.pl -long_titles 4 \ + @(if [ -e developers/imagename_translations ] ; then \ + ./translate_images.pl --to_meaningful_names developers/Bacula_Users_Guide.html; \ + fi) + @rm -rf developers/*.html + latex2html -split 5 -local_icons -t "Developer's Guide" -long_titles 4 \ -contents_in_nav -toc_stars -white -notransparent developers >/dev/null - @echo - @./translate_images.pl --to_meaningful_names developers/Developers_Guide.html + ./translate_images.pl --to_meaningful_names developers/Developers_Guide.html + @cp -f developers/Developers_Guide.html developers/index.html @rm -f *.eps *.gif *.jpg developers/*.eps *.old +show: + xdvi bacula + texcheck: ./check_tex.pl bacula.tex ./check_tex.pl developers.tex @@ -170,7 +154,7 @@ clean: @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg @rm -f *.html *.backup *.pdf *.ps *.dvi *.ilg *.lof *.lot @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd - @rm -f *.dnd + @rm -f *.dnd imagename_translations @rm -f *.old WARNINGS *.out *.toc *.idx @rm -f images.pl labels.pl internals.pl @rm -rf bacula developers @@ -179,4 +163,4 @@ clean: distclean: clean - @rm -f bacula.html bacula.pdf developers.html developers.pdf + @rm -f bacula.html bacula.pdf dev-bacula.pdf developers.html developers.pdf diff --git a/docs/developers/version.tex b/docs/developers/version.tex index 05f79ff7..db8ffb44 100644 --- a/docs/developers/version.tex +++ b/docs/developers/version.tex @@ -1 +1 @@ -1.37.18 +1.37.31 (17 July 2005) diff --git a/docs/developers/version.tex.in b/docs/developers/version.tex.in index d78bda93..ff66dfc6 100644 --- a/docs/developers/version.tex.in +++ b/docs/developers/version.tex.in @@ -1 +1 @@ -@VERSION@ +@VERSION@ (@DATE@) diff --git a/docs/manual/Makefile.in b/docs/manual/Makefile.in index f8780fce..4e2ab7b5 100644 --- a/docs/manual/Makefile.in +++ b/docs/manual/Makefile.in @@ -72,7 +72,7 @@ devpdf: @rm -f *.eps *.old devpdfm: - @echo "Making pdfm" + @echo "Making developers pdfm" @cp -fp ${IMAGES}/hires/*.eps . dvipdfm -p a4 developers.dvi @rm -f *.eps *.old @@ -80,17 +80,13 @@ devpdfm: html: @echo " " @echo "Making html" + @cp -fp ${IMAGES}/*.eps . + @rm -f next.eps next.png prev.eps prev.png up.eps up.png @(if [ -e imagename_translations ] ; then \ ./translate_images.pl --from_meaningful_names bacula.html; \ fi) - @cp -fp ${IMAGES}/*.eps . - @rm -f next.eps next.png prev.eps prev.png up.eps up.png latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \ -init_file latex2html-init.pl bacula >tex.out 2>&1 -# @grep -v "opening brace #41" tex.out >1 -# @mv -f 1 tex.out -# @grep "unmatched" tex.out - @echo " " ./translate_images.pl --to_meaningful_names bacula.html @rm -f *.eps *.gif *.jpg @echo "Done making html" @@ -98,29 +94,27 @@ html: devhtml: @echo "Making developers html" @cp -fp ${IMAGES}/*.eps . + @rm -f next.eps next.png prev.eps prev.png up.eps up.png + @(if [ -e imagename_translations ] ; then \ + ./translate_images.pl --from_meaningful_names developers.html; \ + fi) latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \ developers >/dev/null - ./translate_images.pl developers.html + ./translate_images.pl --to_meaningful_names developers.html @rm -f *.eps *.gif *.jpg *.old web: @echo "Making web" @mkdir -p bacula - @cp -fp ${IMAGES}/*.eps *.txt ${IMAGES}/*.png bacula - @rm -f bacula/xp-*.png - @(if [ -e bacula/imagename_translations ] ; then \ - ./translate_images.pl --from_meaningful_names bacula/Bacula_Users_Guide.html; \ - fi) - @rm -rf bacula/*.html @cp -fp ${IMAGES}/*.eps . @rm -f next.eps next.png prev.eps prev.png up.eps up.png @cp -fp ${IMAGES}/*.eps *.txt bacula + @cp -fp ${IMAGES}/*.eps *.txt ${IMAGES}/*.png bacula + @rm -f bacula/xp-*.png @rm -f bacula/next.eps bacula/next.png bacula/prev.eps bacula/prev.png bacula/up.eps bacula/up.png + @rm -rf bacula/*.html latex2html -split 4 -local_icons -t "Bacula User's Guide" -long_titles 4 \ -toc_stars -contents_in_nav -init_file latex2html-init.pl -white -notransparent bacula >tex.out 2>&1 -# grep -v "opening brace #41" tex.out >1 -# mv -f 1 tex.out -# grep "unmatched" tex.out ./translate_images.pl --to_meaningful_names bacula/Bacula_Users_Guide.html cp -f bacula/Bacula_Freque_Asked_Questi.html bacula/faq.html @rm -f *.eps *.gif *.jpg bacula/*.eps *.old bacula/*.old @@ -134,9 +128,13 @@ devweb: @rm -f next.eps next.png prev.eps prev.png up.eps up.png @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png developers/ @rm -f developers/next.eps developers/next.png developers/prev.eps developers/prev.png developers/up.eps developers/up.png + @(if [ -e developers/imagename_translations ] ; then \ + ./translate_images.pl --to_meaningful_names developers/Bacula_Users_Guide.html; \ + fi) + @rm -rf developers/*.html latex2html -split 5 -local_icons -t "Developer's Guide" -long_titles 4 \ -contents_in_nav -toc_stars -white -notransparent developers >/dev/null - ./translate_images.pl developers/Developers_Guide.html + ./translate_images.pl --to_meaningful_names developers/Developers_Guide.html @cp -f developers/Developers_Guide.html developers/index.html @rm -f *.eps *.gif *.jpg developers/*.eps *.old -- 2.39.5