[Asterisk-doc] docs installation.xml,1.1,1.2
websmith
asterisk-doc@lists.digium.com
Mon, 12 Jan 2004 06:21:49 +0000
Comments:
Update of /cvsroot/asterisk/docs
In directory sc8-pr-cvs1:/tmp/cvs-serv2315
Modified Files:
installation.xml
Log Message:
Added some notes to help us along the way... (In other words, I'm too lazy
to actually fix the things I didn't like. But at least they're documented.)
Index: installation.xml
===================================================================
RCS file: /cvsroot/asterisk/docs/installation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** installation.xml 11 Jan 2004 07:48:26 -0000 1.1
--- installation.xml 12 Jan 2004 06:21:44 -0000 1.2
***************
*** 32,48 ****
<sect3>
<title>Tested Linux Distributions</title>
! <para/>
</sect3>
<sect3>
<title>Minimal Kernel Version</title>
! <para/>
</sect3>
<sect3>
<title>Required Packages</title>
! <para/>
! </sect3>
! <sect3>
! <title/>
! <para/>
</sect3>
</sect2>
--- 32,50 ----
<sect3>
<title>Tested Linux Distributions</title>
! <para>
! [RedHat/Fedora/Debian/Mandrake/Gentoo/etc.]
! </para>
</sect3>
<sect3>
<title>Minimal Kernel Version</title>
! <para>
! [I'm guessing it's 2.4.x, but we should get more clarification]
! </para>
</sect3>
<sect3>
<title>Required Packages</title>
! <para>
! [OpenSSL and its development libraries, and libnewt for zttool]
! </para>
</sect3>
</sect2>
***************
*** 52,64 ****
<sect2>
<title>IRQ Sharing Issues</title>
! <para/>
</sect2>
<sect2>
<title>Digium Cards</title>
<para/>
</sect2>
<sect2>
<title>ISDN Cards</title>
<para>
ISDN Hardware must not be expensive. A basic AVM card
that comes with CAPI compatible kernel modules is available
--- 54,89 ----
<sect2>
<title>IRQ Sharing Issues</title>
! <para>
! [Explain why sharing interrupts is a bad thing, considering
! the number of interrupts that the Digium hardware creates.]
! </para>
</sect2>
<sect2>
<title>Digium Cards</title>
<para/>
+ <sect3>
+ <title>X100P and X101P</title>
+ <para/>
+ </sect3>
+ <sect3>
+ <title>TDM400P</title>
+ <para/>
+ </sect3>
+ <sect3>
+ <title>T100P and E100P</title>
+ <para/>
+ </sect3>
+ <sect3>
+ <title>TE410P (and T400P and E400P)</title>
+ <para/>
+ </sect3>
</sect2>
<sect2>
<title>ISDN Cards</title>
<para>
+ [This is great, but could someone write this in plainer
+ English?]
+ </para>
+ <para>
ISDN Hardware must not be expensive. A basic AVM card
that comes with CAPI compatible kernel modules is available
***************
*** 104,108 ****
<sect2>
<title>The Asterisk "Versioning" Issues</title>
! <para>[Asterisk CVS is often unstable, but until there are regular stable releases, it's about the best you can hope for.]</para>
</sect2>
<sect2>
--- 129,137 ----
<sect2>
<title>The Asterisk "Versioning" Issues</title>
! <para>
! [Stable releases seem to be few and far between, so CVS
! might work better for you... It's not perfect, but it's about
! the best you can hope for.]
! </para>
</sect2>
<sect2>
***************
*** 110,114 ****
<para>
The most common way that people get Asterisk is through CVS. There
! are builds every once in a while, but they become outdated quite quickly.
Your best bet is to get Asterisk from the Digium CVS server and compile it
on your box. Before you start compiling, make sure that your system has
--- 139,143 ----
<para>
The most common way that people get Asterisk is through CVS. There
! are stable release builds every once in a while, but they become outdated quite quickly.
Your best bet is to get Asterisk from the Digium CVS server and compile it
on your box. Before you start compiling, make sure that your system has
***************
*** 116,119 ****
--- 145,152 ----
</para>
<para>
+ [Didn't we already cover these earlier, under required packages?]
+ [Also, why are we being distribution specific in here?]
+ </para>
+ <para>
<simplelist>
<member>OpenSSL and OpenSSL development packages</member>
***************
*** 129,133 ****
<para>
If you are using Debian simply install the required packages with
! <command>apt-get install libreadline4-dev libssl-dev</command> .
</para>
<para>
--- 162,166 ----
<para>
If you are using Debian simply install the required packages with
! <command>apt-get install libssl-dev</command> .
</para>
<para>
***************
*** 150,154 ****
<sect2>
<title>Updates</title>
! <para/>
</sect2>
</sect1>
--- 183,189 ----
<sect2>
<title>Updates</title>
! <para>
! [Explain how to do a CVS update (if they're using CVS)]
! </para>
</sect2>
</sect1>
***************
*** 159,162 ****
--- 194,198 ----
<para>Now we need to compile Asterisk as root :
<!-- We may need to clean up this section a bit as the way it is laid out is a little weird -->
+ [Take this out... it's explained below under "Compiling the software"]
</para>
<para>
***************
*** 171,177 ****
</para>
<para>
! Depending on how fast your machine is, this will
! take a few minutes. On my Celeron 633 with 256 MB
! of RAM, this takes about 10-15 minutes. At the end
of the configuration it will ask you if you want to
make samples, don't bother with that, as we are going
--- 207,212 ----
</para>
<para>
! Depending on how fast your machine is, this will
! take a few minutes. At the end
of the configuration it will ask you if you want to
make samples, don't bother with that, as we are going
***************
*** 180,191 ****
fit our system)
</para>
- <para>
- If you want to install the asterisk initscript in
- <command>/etc/rc.d/init.d/</command> then you can type
- <command>make clean</command> in your <command>/usr/src/asterisk/</command>
- directory. Then you can start and stop Asterisk quite
- easily by doing
- <command>/etc/rc.d/init.d/asterisk {start|stop|reload|restart|status}</command>
- </para>
</sect2>
<sect2>
--- 215,218 ----
***************
*** 220,223 ****
--- 247,254 ----
</sect3>
<sect3>
+ <title>Requirements for Doxygen</title>
+ <para/>
+ </sect3>
+ <sect3>
<title>Code Documentation Layout</title>
<para/>
***************
*** 226,229 ****
--- 257,263 ----
<sect2>
<title>Building additional modules</title>
+ <para>
+ [Should this be here, or somewhere else?]
+ </para>
<sect3>
<title>H323 - McNamara</title>
***************
*** 288,292 ****
</para>
<para>
! <command>load => chan_capi.so*</command>
</para>
<para>
--- 322,326 ----
</para>
<para>
! <command>load => chan_capi.so</command>
</para>
<para>
***************
*** 297,301 ****
</para>
<para>
! After these steps your channel-module is available in * but it has to be
configured. This is done in the main CAPI configuration file <filename>capi.conf</filename>.
</para>
--- 331,335 ----
</para>
<para>
! After these steps your channel module is available in Asterisk but it has to be
configured. This is done in the main CAPI configuration file <filename>capi.conf</filename>.
</para>
***************
*** 344,349 ****
<title>Starting Asterisk using safe_asterisk</title>
<para>
! You can start Asterisk as a daemon using the safe_asterisk script located
! in /usr/sbin/
</para>
<para>
--- 378,386 ----
<title>Starting Asterisk using safe_asterisk</title>
<para>
! [Explain why you'd want to use safe_asterisk]
! </para>
! <para>
! You can start Asterisk as a daemon using the <filename>safe_asterisk </filename> script located
! in <filename class='directory'>/usr/sbin/</filename>
</para>
<para>
***************
*** 357,360 ****
--- 394,400 ----
switch.
</para>
+ <para>
+ [Please, let's be more specific here. And maybe give an example.]
+ </para>
</sect2>
<sect2>