From bfdbde12e36b555bcc445cb7828a6b2a2f0fbb9d Mon Sep 17 00:00:00 2001 From: maroy <maroy@cfc7b370-4200-0410-a6e3-cb6bdb053afe> Date: Wed, 19 Jan 2005 13:16:36 +0000 Subject: [PATCH] added development tools document --- livesupport/doc/developmentTools.html | 60 +++++++++++++++++++++++++++ livesupport/doc/gettingStarted.html | 47 +++++++++++---------- livesupport/doc/index.html | 12 +++--- 3 files changed, 91 insertions(+), 28 deletions(-) create mode 100644 livesupport/doc/developmentTools.html diff --git a/livesupport/doc/developmentTools.html b/livesupport/doc/developmentTools.html new file mode 100644 index 000000000..ad27e51d2 --- /dev/null +++ b/livesupport/doc/developmentTools.html @@ -0,0 +1,60 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <meta content="text/html; charset=UTF-8" http-equiv="content-type"> + <title>LiveSupport developer tools</title> + <meta content="$Author: maroy $" name="author"> +</head> +<body> +<h1>Preface</h1> +This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a> +project, Copyright © 2004 <a href="http://www.mdlf.org/">Media +Development Loan Fund</a>, under the GNU <a + href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br> +<ul> + <li>Author: $Author: maroy $</li> + <li>Version: $Revision: 1.1 $</li> + <li>Location: $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentTools.html,v $</li> +</ul> +<h1>Scope</h1> +This document lists the development tools that are expected to be on a +system that intends to compile and develop LiveSupport.<br> +<h1>Introduction</h1> +LiveSupport expects a generic development environment on the system to +be built, which is basically a generic install of a POSIX-compliant +operating system, with a set of GNU development tools and some +utilities.<br> +<h1>Tools</h1> +The following tools are expected on the development system:<br> +<ul> + <li><a href="http://sources.redhat.com/binutils/">binutils</a> >= +2.13</li> + <li><a href="http://gcc.gnu.org/">gcc</a> >= 3.3</li> + <li><a href="http://www.gnu.org/software/make/make.html">make</a> +>= 3.80</li> + <li><a href="http://www.gnu.org/software/automake/">automake</a> < +1.9</li> + <li><a href="http://www.gnu.org/software/autoconf/">autoconf</a> +>= 2.5</li> + <li><a href="http://www.freedesktop.org/software/pkgconfig/">pkgconfig</a> +>= 0.15</li> + <li><a href="http://www.fsf.org/software/patch/patch.html">patch</a> +>= 2.5.9<br> + </li> + <li><a href="http://www.doxygen.org/">doxygen</a></li> + <li><a href="http://www.gnu.org/software/tar/">tar</a></li> + <li><a href="http://www.gzip.org/">gzip</a></li> + <li><a href="http://sources.redhat.com/bzip2/">bzip2</a><br> + </li> +</ul> +<h1>Libraries</h1> +The following development libraries are expected on the development +system:<br> +<ul> + <li><a href="http://www.unixodbc.org/">unixODBC</a> >= 2.2</li> + <li><a href="http://xorg.freedesktop.org/">xorg-x11</a></li> + <li><a href="http://www.libpng.org/">libpng</a></li> +</ul> +<br> +</body> +</html> diff --git a/livesupport/doc/gettingStarted.html b/livesupport/doc/gettingStarted.html index aa0b3ca7b..29574a96c 100644 --- a/livesupport/doc/gettingStarted.html +++ b/livesupport/doc/gettingStarted.html @@ -3,7 +3,7 @@ <head> <meta content="text/html; charset=UTF-8" http-equiv="content-type"> <title>Getting started with the LiveSupport development environment</title> - <meta content="$Author: tomas $" name="author"> + <meta content="$Author: maroy $" name="author"> </head> <body> <h1>Preface</h1> @@ -12,8 +12,8 @@ project, Copyright © 2004 <a href="http://www.mdlf.org/">Media Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br> <ul> - <li>Author: $Author: tomas $</li> - <li>Version: $Revision: 1.5 $</li> + <li>Author: $Author: maroy $</li> + <li>Version: $Revision: 1.6 $</li> <li>Location: $Source: /home/cvs/livesupport/doc/gettingStarted.html,v $</li> </ul> @@ -31,10 +31,16 @@ used to develop LiveSupport as well.<br> The following steps needed to be taken for setting up the LiveSupport development environment.<br> <ul> + <li>install development tools<br> + </li> <li>set up additional system resources</li> <li>check out the sources</li> <li>set up tools used by LiveSupport</li> </ul> +<h2>Install development tools</h2> +Install all the tools needed for the development of LiveSupport. Please +see the <a href="developmentTools.html">development tools</a> document +for a list of tools needed.<br> <h2>Set up additional system resources</h2> The LiveSupport development environment uses some system resources, that are not reasonable to include in the environment itself. One such @@ -42,8 +48,8 @@ resource is an ODBC datasource to a test database. This database has to be accessible for executing the test suites and applications within the LiveSupport development environment.<br> <br> -First, LiveSupport expects a <a - href="http://www.postgresql.org/">PostgreSQL</a> database, and an ODBC +First, LiveSupport expects a <a href="http://www.postgresql.org/">PostgreSQL</a> +database, and an ODBC Data Source accessible to it through <a href="http://www.unixodbc.org/">unixODBC</a>. Please refer to the documentation of these tools to set them up.<br> <br> @@ -60,35 +66,30 @@ regularly create and destroy database tables.<br> Second, LiveSupport expects: <ul> <li><a href="http://httpd.apache.org/">Apache</a> httpd server - running on the development computer</li> +running on the development computer</li> <li><a href="http://www.php.net/">PHP</a> interpreter</li> <li><a href="http://www.php.net/">PHP</a> apache module</li> <li><a href="http://www.postgresql.org/">PostgreSQL</a> support in PHP</li> - <li><a href="http://pear.php.net/">PEAR</a> DB module - (may be checked: <code>pear list</code> - and installed by: <code>pear install DB</code>)</li> + <li><a href="http://pear.php.net/">PEAR</a> DB module (may be +checked: <code>pear list</code> and installed by: <code>pear install +DB</code>)</li> <!-- <li><a href="http:///"></a></li>--> </ul> Please, check settings in <code>var/conf.php</code> files in both storageServer and archiveServer modules and create two -symlinks with name corresponding to "URL configuration" part of +symlinks with name corresponding to "URL configuration" part of <code>var/conf.php</code> files - example for default values: <ul> - <li> - <code>http://localhost:80/livesupportStorageServer/</code> should point - to the - <code><livesupport-cvs>/modules/storageServer/var</code> directory - </li> - <li> - <code>http://localhost:80/livesupportArchiveServer/</code> should point - to the - <code><livesupport-cvs>/modules/archiveServer/var</code> directory - </li> + <li> <code>http://localhost:80/livesupportStorageServer/</code> +should point to the <code><livesupport-cvs>/modules/storageServer/var</code> +directory </li> + <li> <code>http://localhost:80/livesupportArchiveServer/</code> +should point to the <code><livesupport-cvs>/modules/archiveServer/var</code> +directory </li> </ul> -And setup a file-uploading support as described in the -<code>modules/archiveServer/doc/INSTALL</code> file (included with the +And setup a file-uploading support as described in the <code>modules/archiveServer/doc/INSTALL</code> +file (included with the sources). - <h2>Check out the sources</h2> The LiveSupport development directory tree can be accessed via anonymous <a href="https://www.cvshome.org/">CVS</a>, using the diff --git a/livesupport/doc/index.html b/livesupport/doc/index.html index c04d5d3fb..9dc9353eb 100644 --- a/livesupport/doc/index.html +++ b/livesupport/doc/index.html @@ -3,7 +3,7 @@ <head> <meta content="text/html; charset=UTF-8" http-equiv="content-type"> <title>LiveSupport developer documentation</title> - <meta content="$Author: tomas $" name="author"> + <meta content="$Author: maroy $" name="author"> </head> <body> <h1>Preface</h1> @@ -12,8 +12,8 @@ project, Copyright © 2004 <a href="http://www.mdlf.org/">Media Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br> <ul> - <li>Author: $Author: tomas $</li> - <li>Version: $Revision: 1.3 $</li> + <li>Author: $Author: maroy $</li> + <li>Version: $Revision: 1.4 $</li> <li>Location: $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/index.html,v $</li> </ul> <h1>Scope</h1> @@ -22,11 +22,13 @@ generated and handwritten.<br> <h1>Introduction</h1> The links below provide useful documentation for the LiveSupport developer.<br> -<h1>Static documentaiton.<br> +<h1>Static documentaiton<br> </h1> <ul> <li><a href="gettingStarted.html">getting started</a> with -LiveSupport development<br> +LiveSupport development</li> + <li><a href="developmentTools.html">development tools</a> neded to +compile LiveSupport<br> </li> <li>LiveSupport <a href="developmentEnvironment/index.html">development environment</a></li>