mirror of
				https://github.com/asterisk/asterisk.git
				synced 2025-11-04 05:15:22 +00:00 
			
		
		
		
	* 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 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@72982 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
		
							
								
								
									
										18
									
								
								Makefile
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								Makefile
									
									
									
									
									
								
							@@ -699,22 +699,4 @@ menuselect-tree: $(foreach dir,$(filter-out main,$(MOD_SUBDIRS)),$(wildcard $(di
 | 
			
		||||
 | 
			
		||||
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
 | 
			
		||||
 
 | 
			
		||||
@@ -9,4 +9,6 @@ make -C sounds all MENUSELECT_CORE_SOUNDS=CORE-SOUNDS-EN-GSM MENUSELECT_MOH=MOH-
 | 
			
		||||
 | 
			
		||||
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
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										35
									
								
								doc/tex/Makefile
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										35
									
								
								doc/tex/Makefile
									
									
									
									
									
										Normal file
									
								
							@@ -0,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
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										24
									
								
								doc/tex/README.txt
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								doc/tex/README.txt
									
									
									
									
									
										Normal file
									
								
							@@ -0,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.
 | 
			
		||||
@@ -22,7 +22,7 @@ This document contains various pieces of information that are useful for
 | 
			
		||||
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 @@ reference purposes.
 | 
			
		||||
  \section{Introduction}
 | 
			
		||||
  \input{dundi.tex}
 | 
			
		||||
  \section{Peering Agreement}
 | 
			
		||||
  \input{PEERING}
 | 
			
		||||
  \input{../PEERING}
 | 
			
		||||
 | 
			
		||||
\chapter{ENUM}
 | 
			
		||||
\input{enum.tex}
 | 
			
		||||
		Reference in New Issue
	
	Block a user