[svn-commits] russell: trunk r72982 - in /trunk: ./ build_tools/ doc/ doc/tex/

SVN commits to the Digium repositories svn-commits at lists.digium.com
Mon Jul 2 17:27:48 CDT 2007


Author: russell
Date: Mon Jul  2 17:27:46 2007
New Revision: 72982

URL: http://svn.digium.com/view/asterisk?view=rev&rev=72982
Log:
* Move LaTeX docs into a tex/ subdirectory of the doc/ dir
* Add a Makefile in doc/tex/ for generating PDF and HTML
* Add a README.txt file to doc/tex/ to document which tools are used and what
  web sites to visit for getting them.
* Update build_tools/prep_tarball to put the proper Asterisk version string
  in the automatically generated PDF for release tarballs

Added:
    trunk/doc/tex/
    trunk/doc/tex/Makefile   (with props)
    trunk/doc/tex/README.txt   (with props)
    trunk/doc/tex/ael.tex
      - copied unchanged from r72926, trunk/doc/ael.tex
    trunk/doc/tex/ajam.tex
      - copied unchanged from r72926, trunk/doc/ajam.tex
    trunk/doc/tex/app-sms.tex
      - copied unchanged from r72926, trunk/doc/app-sms.tex
    trunk/doc/tex/ast_agi_commands.tex
      - copied unchanged from r72939, trunk/doc/ast_agi_commands.tex
    trunk/doc/tex/ast_appdocs.tex
      - copied unchanged from r72926, trunk/doc/ast_appdocs.tex
    trunk/doc/tex/ast_cli_commands.tex
      - copied unchanged from r72938, trunk/doc/ast_cli_commands.tex
    trunk/doc/tex/ast_funcdocs.tex
      - copied unchanged from r72926, trunk/doc/ast_funcdocs.tex
    trunk/doc/tex/ast_manager_actiondocs.tex
      - copied unchanged from r72929, trunk/doc/ast_manager_actiondocs.tex
    trunk/doc/tex/asterisk-conf.tex
      - copied unchanged from r72926, trunk/doc/asterisk-conf.tex
    trunk/doc/tex/asterisk.tex
      - copied, changed from r72938, trunk/doc/asterisk.tex
    trunk/doc/tex/billing.tex
      - copied unchanged from r72926, trunk/doc/billing.tex
    trunk/doc/tex/cdrdriver.tex
      - copied unchanged from r72926, trunk/doc/cdrdriver.tex
    trunk/doc/tex/chaniax.tex
      - copied unchanged from r72926, trunk/doc/chaniax.tex
    trunk/doc/tex/channelvariables.tex
      - copied unchanged from r72926, trunk/doc/channelvariables.tex
    trunk/doc/tex/cliprompt.tex
      - copied unchanged from r72926, trunk/doc/cliprompt.tex
    trunk/doc/tex/configuration.tex
      - copied unchanged from r72926, trunk/doc/configuration.tex
    trunk/doc/tex/dundi.tex
      - copied unchanged from r72926, trunk/doc/dundi.tex
    trunk/doc/tex/enum.tex
      - copied unchanged from r72926, trunk/doc/enum.tex
    trunk/doc/tex/extensions.tex
      - copied unchanged from r72926, trunk/doc/extensions.tex
    trunk/doc/tex/freetds.tex
      - copied unchanged from r72926, trunk/doc/freetds.tex
    trunk/doc/tex/hardware.tex
      - copied unchanged from r72926, trunk/doc/hardware.tex
    trunk/doc/tex/ices.tex
      - copied unchanged from r72926, trunk/doc/ices.tex
    trunk/doc/tex/imapstorage.tex
      - copied unchanged from r72926, trunk/doc/imapstorage.tex
    trunk/doc/tex/jitterbuffer.tex
      - copied unchanged from r72926, trunk/doc/jitterbuffer.tex
    trunk/doc/tex/localchannel.tex
      - copied unchanged from r72926, trunk/doc/localchannel.tex
    trunk/doc/tex/manager.tex
      - copied unchanged from r72926, trunk/doc/manager.tex
    trunk/doc/tex/misdn.tex
      - copied unchanged from r72926, trunk/doc/misdn.tex
    trunk/doc/tex/mp3.tex
      - copied unchanged from r72926, trunk/doc/mp3.tex
    trunk/doc/tex/odbcstorage.tex
      - copied unchanged from r72926, trunk/doc/odbcstorage.tex
    trunk/doc/tex/privacy.tex
      - copied unchanged from r72926, trunk/doc/privacy.tex
    trunk/doc/tex/qos.tex
      - copied unchanged from r72926, trunk/doc/qos.tex
    trunk/doc/tex/queuelog.tex
      - copied unchanged from r72926, trunk/doc/queuelog.tex
    trunk/doc/tex/queues-with-callback-members.tex
      - copied unchanged from r72926, trunk/doc/queues-with-callback-members.tex
    trunk/doc/tex/realtime.tex
      - copied unchanged from r72926, trunk/doc/realtime.tex
    trunk/doc/tex/security.tex
      - copied unchanged from r72926, trunk/doc/security.tex
    trunk/doc/tex/sla.tex
      - copied unchanged from r72926, trunk/doc/sla.tex
Removed:
    trunk/doc/ael.tex
    trunk/doc/ajam.tex
    trunk/doc/app-sms.tex
    trunk/doc/ast_agi_commands.tex
    trunk/doc/ast_appdocs.tex
    trunk/doc/ast_cli_commands.tex
    trunk/doc/ast_funcdocs.tex
    trunk/doc/ast_manager_actiondocs.tex
    trunk/doc/asterisk-conf.tex
    trunk/doc/asterisk.tex
    trunk/doc/billing.tex
    trunk/doc/cdrdriver.tex
    trunk/doc/chaniax.tex
    trunk/doc/channelvariables.tex
    trunk/doc/cliprompt.tex
    trunk/doc/configuration.tex
    trunk/doc/dundi.tex
    trunk/doc/enum.tex
    trunk/doc/extensions.tex
    trunk/doc/freetds.tex
    trunk/doc/hardware.tex
    trunk/doc/ices.tex
    trunk/doc/imapstorage.tex
    trunk/doc/jitterbuffer.tex
    trunk/doc/localchannel.tex
    trunk/doc/manager.tex
    trunk/doc/misdn.tex
    trunk/doc/mp3.tex
    trunk/doc/odbcstorage.tex
    trunk/doc/privacy.tex
    trunk/doc/qos.tex
    trunk/doc/queuelog.tex
    trunk/doc/queues-with-callback-members.tex
    trunk/doc/realtime.tex
    trunk/doc/security.tex
    trunk/doc/sla.tex
Modified:
    trunk/Makefile
    trunk/build_tools/prep_tarball

Modified: trunk/Makefile
URL: http://svn.digium.com/view/asterisk/trunk/Makefile?view=diff&rev=72982&r1=72981&r2=72982
==============================================================================
--- trunk/Makefile (original)
+++ trunk/Makefile Mon Jul  2 17:27:46 2007
@@ -699,22 +699,4 @@
 
 asterisk.pdf: doc/asterisk.pdf
 
-doc/asterisk.pdf: $(wildcard doc/*.tex)
-ifeq ($(findstring rubber,$(RUBBER)),)
-	@echo "**********************************************"
-	@echo "** You must install the \"rubber\" tool      ***"
-	@echo "** to generate the Asterisk reference PDF. ***"
-	@echo "**********************************************"
-else
-	@echo "**********************************************"
-	@echo "** The Asterisk reference PDF will now be  ***"
-	@echo "** generated.  When complete, it will be   ***"
-	@echo "** located at doc/asterisk.pdf.            ***"	
-	@echo "**********************************************"
-	@cp doc/asterisk.tex doc/asterisk.tex.orig
-	@sed -i -e 's/ASTERISKVERSION/$(ASTERISKVERSION)/' doc/asterisk.tex
-	@cd doc && $(RUBBER) --pdf asterisk.tex
-	@mv doc/asterisk.tex.orig doc/asterisk.tex
-endif
-
 .PHONY: menuselect main sounds clean dist-clean distclean all prereqs cleantest uninstall _uninstall uninstall-all dont-optimize $(SUBDIRS_INSTALL) $(SUBDIRS_CLEAN) $(SUBDIRS_UNINSTALL) $(SUBDIRS) $(MOD_SUBDIRS_EMBED_LDSCRIPT) $(MOD_SUBDIRS_EMBED_LDFLAGS) $(MOD_SUBDIRS_EMBED_LIBS) menuselect.makeopts

Modified: trunk/build_tools/prep_tarball
URL: http://svn.digium.com/view/asterisk/trunk/build_tools/prep_tarball?view=diff&rev=72982&r1=72981&r2=72982
==============================================================================
--- trunk/build_tools/prep_tarball (original)
+++ trunk/build_tools/prep_tarball Mon Jul  2 17:27:46 2007
@@ -9,4 +9,6 @@
 
 make menuselect-tree
 
-cd doc && rubber --pdf asterisk.tex
+VERSION=`cat .version`
+sed -i -e "s/ASTERISKVERSION/${VERSION}/" doc/tex/asterisk.tex
+cd doc/tex && rubber --pdf asterisk.tex

Added: trunk/doc/tex/Makefile
URL: http://svn.digium.com/view/asterisk/trunk/doc/tex/Makefile?view=auto&rev=72982
==============================================================================
--- trunk/doc/tex/Makefile (added)
+++ trunk/doc/tex/Makefile Mon Jul  2 17:27:46 2007
@@ -1,0 +1,35 @@
+include ../../makeopts
+
+pdf: asterisk.pdf
+
+asterisk.pdf: $(wildcard *.tex)
+ifeq ($(findstring rubber,$(RUBBER)),)
+	@echo "**********************************************"
+	@echo "** You must install the \"rubber\" tool      ***"
+	@echo "** to generate the Asterisk reference PDF. ***"
+	@echo "**********************************************"
+else
+	@echo "**********************************************"
+	@echo "** The Asterisk reference PDF will now be  ***"
+	@echo "** generated.  When complete, it will be   ***"
+	@echo "** located at asterisk.pdf.                ***"	
+	@echo "**********************************************"
+	@cp asterisk.tex asterisk.tex.orig
+	@sed -i -e 's/ASTERISKVERSION/$(ASTERISKVERSION)/' asterisk.tex
+	@$(RUBBER) --pdf asterisk.tex
+	@mv asterisk.tex.orig asterisk.tex
+endif
+
+html:
+	@echo "**********************************************"
+	@echo "** The Asterisk reference HTML will now be ***"
+	@echo "** generated.  When complete, it will be   ***"
+	@echo "** located in the asterisk/ directory.     ***"	
+	@echo "** Note that the latex2html tool is        ***"	
+	@echo "** required for this to work.              ***"	
+	@echo "**********************************************"
+	@cp asterisk.tex asterisk.tex.orig
+	@sed -i -e 's/ASTERISKVERSION/$(ASTERISKVERSION)/' asterisk.tex
+	@latex2html asterisk.tex
+	@mv asterisk.tex.orig asterisk.tex
+

Propchange: trunk/doc/tex/Makefile
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: trunk/doc/tex/Makefile
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Propchange: trunk/doc/tex/Makefile
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: trunk/doc/tex/README.txt
URL: http://svn.digium.com/view/asterisk/trunk/doc/tex/README.txt?view=auto&rev=72982
==============================================================================
--- trunk/doc/tex/README.txt (added)
+++ trunk/doc/tex/README.txt Mon Jul  2 17:27:46 2007
@@ -1,0 +1,24 @@
+Asterisk Reference Documentation
+--------------------------------
+
+1) To generate a PDF from this documentation, you will need the rubber tool,
+   and all of its dependencies.  The web site for this tool is:
+
+      http://www.pps.jussieu.fr/~beffara/soft/rubber/
+
+   Then, once this tool is installed, running "make pdf" will generate
+   the PDF automatically using this tool.  The result will be asterisk.pdf.
+
+   NOTE:  After installing rubber, you will need to re-run the top level
+   configure script.  It checks to see if rubber is installed, so that the
+   asterisk.pdf Makefile target can produce a useful error message when it is
+   not installed.
+
+2) To generate HTML from this documentation, you will need the latex2html tool,
+   and all of its dependencies.  The web site for this tool is:
+
+      http://www.latex2html.org/
+
+   Then, once this tool is installed, running "make html" will generate the
+   HTML documentation.  The result will be an asterisk directory full of
+   HTML files.

Propchange: trunk/doc/tex/README.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: trunk/doc/tex/README.txt
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Propchange: trunk/doc/tex/README.txt
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Copied: trunk/doc/tex/asterisk.tex (from r72938, trunk/doc/asterisk.tex)
URL: http://svn.digium.com/view/asterisk/trunk/doc/tex/asterisk.tex?view=diff&rev=72982&p1=trunk/doc/asterisk.tex&r1=72938&p2=trunk/doc/tex/asterisk.tex&r2=72982
==============================================================================
--- trunk/doc/asterisk.tex (original)
+++ trunk/doc/tex/asterisk.tex Mon Jul  2 17:27:46 2007
@@ -22,7 +22,7 @@
 reference purposes.
 
   \section{License Information}
-  \input{../LICENSE}
+  \input{../../LICENSE}
      \subsection{Hold Music}
        Digium has licensed the music included with
        the Asterisk distribution From FreePlayMusic
@@ -81,7 +81,7 @@
   \section{Introduction}
   \input{dundi.tex}
   \section{Peering Agreement}
-  \input{PEERING}
+  \input{../PEERING}
 
 \chapter{ENUM}
 \input{enum.tex}




More information about the svn-commits mailing list