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.


git-svn-id: http://svn.asterisk.org/svn/dahdi/tools/trunk@4859 a0bf4364-ded3-4de4-8d8a-66a801d63aff

1 files changed, 46 insertions, 33 deletions

diff --git a/UPGRADE.txt b/UPGRADE.txt
index 9cf4d5b..5868d47 100644
--- a/UPGRADE.txt
+++ b/UPGRADE.txt
@@ -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 @@ to Zaptel, even if Zaptel is still installed on the system.
 
 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:
+
+* dahdi-linux: kernel modules
+* dahdi-tools: userspace tools
+
+In addition, there is a dahdi-linux-complete package that contains both
+dahdi-linux and dahdi-tools for simplified installation.
 
-  In addition, there is a dahdi-linux-complete package that contains both
-  dahdi-linux and dahdi-tools for simplified installation.
+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.
 
-  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.
 
-Notes about the dahdi-linux package:
+DAHDI-Linux
+~~~~~~~~~~~
+Module Names
+^^^^^^^^^^^^
+The primary kernel modules have changed names; the new names are:
 
-* 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 @@ Notes about the dahdi-linux package:
   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. 
+
+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.
+
+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.
+
 
-Notes about the dahdi-tools package:
+DAHDI-Tools
+~~~~~~~~~~~
+Many tool names have changed:
 
-* Many tool names have changed:
       ztcfg      ->  dahdi_cfg
       ztmonitor  ->  dahdi_monitor
       ztscan     ->  dahdi_scan
@@ -69,7 +82,7 @@ Notes about the dahdi-tools package:
       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