[dahdi-commits] tzafrir: tools/trunk r4859 - in /tools/trunk: Makefile README UPGRADE.txt

Wed Sep 3 14:38:33 CDT 2008

Author: tzafrir
Date: Wed Sep  3 14:38:32 2008
New Revision: 4859

URL: http://svn.digium.com/view/dahdi?view=rev&rev=4859
Log:
Slightly reformat UPDATES.txt for asciidoc . Include it in README.html .
See e.g. http://docs.tzafrir.org.il/dahdi-tools/README.html#_upgrade_notes

Also fix some links in the README.

Modified:
    tools/trunk/Makefile
    tools/trunk/README
    tools/trunk/UPGRADE.txt

Modified: tools/trunk/Makefile
URL: http://svn.digium.com/view/dahdi/tools/trunk/Makefile?view=diff&rev=4859&r1=4858&r2=4859
==============================================================================

--- tools/trunk/Makefile (original)
+++ tools/trunk/Makefile Wed Sep  3 14:38:32 2008
@@ -192,7 +192,7 @@
 
 docs: $(GENERATED_DOCS)
 
-README.html: README system.conf.asciidoc init.conf.asciidoc tonezones.txt
+README.html: README system.conf.asciidoc init.conf.asciidoc tonezones.txt UPGRADE.txt
 	$(ASCIIDOC) -n -a toc -a toclevels=3 $<
 
 README.Astribank.html: xpp/README.Astribank

Modified: tools/trunk/README
URL: http://svn.digium.com/view/dahdi/tools/trunk/README?view=diff&rev=4859&r1=4858&r2=4859
==============================================================================
--- tools/trunk/README (original)
+++ tools/trunk/README Wed Sep  3 14:38:32 2008
@@ -206,6 +206,9 @@
    CONFIG_HDLC .
 
 
+include::UPGRADE.txt[]
+
+
 License
 -------
 This package is distributed under the terms of the GNU General Public License
@@ -222,13 +225,13 @@
 Reporting Bugs
 --------------
 Please report bug and patches to the Asterisk bug tracker at
-http://bugs.digium.com in the "DAHDI" category.
+http://bugs.digium.com/[] in the "DAHDI" category.
 
 
 Links
 -----
 - http://asterisk.org/[] - The Asterisk PBX
 - http://voip-info.org/[]
-- http://voip-info.org/wiki/view/Asterisk+Zaptel+Installation[]
+- http://voip-info.org/wiki/view/DAHDI[]
 - http://docs.tzafrir.org.il/dahdi-tools/README.html[Up-to-date HTML version
   of this file]

Modified: tools/trunk/UPGRADE.txt
URL: http://svn.digium.com/view/dahdi/tools/trunk/UPGRADE.txt?view=diff&rev=4859&r1=4858&r2=4859
==============================================================================
--- tools/trunk/UPGRADE.txt (original)
+++ tools/trunk/UPGRADE.txt Wed Sep  3 14:38:32 2008
@@ -1,6 +1,7 @@
-=====================================================================
-=== Information for upgrading from Zaptel 1.2 or 1.4 to DAHDI 2.0 ===
-=====================================================================
+Upgrade Notes
+-------------
+
+Information for upgrading from Zaptel 1.2 or 1.4 to DAHDI 2.0
 
 Upgrading from Zaptel to DAHDI is fairly straightforward; install this
 package using the installation instructions, and then reconfigure and
@@ -10,25 +11,30 @@
 
 Important notes about upgrading:
 
-* The Zaptel package, which included both kernel modules and userspace
-  tools for configuring and managing the modules, has been split into
-  two packages:
-      dahdi-linux: kernel modules
-      dahdi-tools: userspace tools
+The Zaptel package, which included both kernel modules and userspace
+tools for configuring and managing the modules, has been split into
+two packages:
 
-  In addition, there is a dahdi-linux-complete package that contains both
-  dahdi-linux and dahdi-tools for simplified installation.
+* dahdi-linux: kernel modules
+* dahdi-tools: userspace tools
 
-  Note: The dahdi-linux and dahdi-tools packages have *separate*
-  version numbers; they will not be released 'in sync', and it is
-  perfectly acceptable to use (for example) dahdi-tools 2.0.6 with
-  dahdi-linux 2.0.11. The dahdi-linux-complete package version number will
-  always include *both* of these version numbers so that you will know
-  what is included in it.
+In addition, there is a dahdi-linux-complete package that contains both
+dahdi-linux and dahdi-tools for simplified installation.
 
-Notes about the dahdi-linux package:
+NOTE: The dahdi-linux and dahdi-tools packages have *separate*
+version numbers; they will not be released 'in sync', and it is
+perfectly acceptable to use (for example) dahdi-tools 2.0.6 with
+dahdi-linux 2.0.11. The dahdi-linux-complete package version number will
+always include *both* of these version numbers so that you will know
+what is included in it.
 
-* The primary kernel modules have changed names; the new names are:
+
+DAHDI-Linux
+~~~~~~~~~~~
+Module Names
+^^^^^^^^^^^^
+The primary kernel modules have changed names; the new names are:
+
       zaptel.ko	     ->	     dahdi.ko
       ztd-eth.ko     ->	     dahdi_dynamic_eth.ko
       ztd-loc.ko     ->	     dahdi_dynamic_loc.ko
@@ -43,23 +49,30 @@
   choosing which modules to build; all modules that can be built are
   built automatically.
 
-* It is no longer possible to select a software echo canceler at
-  compile time to build into dahdi.ko; all four included echo
-  cancelers (MG2, KB1, SEC and SEC2) are built as loadable modules,
-  and if the Digium HPEC binary object file has been placed into the
-  proper directory the HPEC module will be built as well. Any or all
-  of these modules can be loaded at the same time, and the echo
-  canceler to be used on the system's channels can be configured using
-  the dahdi_cfg tool from the dahdi-tools package.
 
-  Note: It is *mandatory* to configure an echo canceler for the
-  system's channels using dahdi_cfg unless the interface cards in use
-  have echo canceler modules available and enabled. There is *no*
-  default software echo canceler with DAHDI.
+Echo Canceller Modules
+^^^^^^^^^^^^^^^^^^^^^^
+It is no longer possible and needed to select a software echo canceler 
+at compile time to build into dahdi.ko; all four included echo
+cancelers (MG2, KB1, SEC and SEC2) are built as loadable modules.
+If the Digium HPEC binary object file has been placed into the
+proper directory the HPEC module will be built as well. 
 
-Notes about the dahdi-tools package:
+Any or all of these modules can be loaded at the same time, and the echo
+canceler to be used on the system's channels can be configured using
+the dahdi_cfg tool from the dahdi-tools package.
 
-* Many tool names have changed:
+IMPORTANT: It is *mandatory* to configure an echo canceler for the
+system's channels using dahdi_cfg unless the interface cards in use
+have echo canceler modules available and enabled. There is *no*
+default software echo canceler with DAHDI. See
+<<_echo_cancellers,section on echo cancellers>> in sample system.conf.
+
+
+DAHDI-Tools
+~~~~~~~~~~~
+Many tool names have changed:
+
       ztcfg      ->  dahdi_cfg
       ztmonitor  ->  dahdi_monitor
       ztscan     ->  dahdi_scan
@@ -69,7 +82,7 @@
       zapconf    ->  dahdi_genconf (deprecates genzaptelconf)
 
 * The system configuration file has moved from /etc/zaptel.conf to
-  /etc/dahdi/system.conf.
+  <<_sample_system_conf,/etc/dahdi/system.conf>>.
 
 * The dahdi_cfg tool can now be used to select an echo canceler on a
   channel-by-channel basis in the system configuration file; see


