From c3fd7b9be1d4fb6c8bb027748366365d634092a7 Mon Sep 17 00:00:00 2001 From: maroy Date: Sat, 24 Jul 2004 13:50:08 +0000 Subject: [PATCH] added setup target to main Makefile, and getting started document --- livesupport/Makefile | 61 ++++++++++++++++-- livesupport/doc/gettingStarted.html | 96 +++++++++++++++++++++++++++++ 2 files changed, 153 insertions(+), 4 deletions(-) create mode 100644 livesupport/doc/gettingStarted.html diff --git a/livesupport/Makefile b/livesupport/Makefile index 0ca2df24d..3059d75d6 100644 --- a/livesupport/Makefile +++ b/livesupport/Makefile @@ -21,7 +21,7 @@ # # # Author : $Author: maroy $ -# Version : $Revision: 1.2 $ +# Version : $Revision: 1.3 $ # Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/Attic/Makefile,v $ #------------------------------------------------------------------------------- @@ -33,6 +33,7 @@ RM = rm -f RMDIR = rm -rf DOXYGEN = doxygen XSLTPROC = xsltproc +ECHO = @echo #------------------------------------------------------------------------------- @@ -49,15 +50,49 @@ TESTRESULTS_XSLT = ${ETC_DIR}/testResultsToHtml.xsl TESTRESULTS_IN = ${ETC_DIR}/testResults.xml TESTRESULTS_FILE = ${DOC_DIR}/testResults.html +TOOLS_DIR = ${BASE_DIR}/tools + +BOOST_DIR = ${TOOLS_DIR}/boost +BOOST_VERSION = boost-1.31 +LIBXMLXX_DIR = ${TOOLS_DIR}/libxml++ +LIBXMLXX_VERSION = libxml++-1.0.4 +CXXUNIT_DIR = ${TOOLS_DIR}/cppunit +CXXUNIT_VERSION = cppunit-1.10.2 +LIBODBCXX_DIR = ${TOOLS_DIR}/libodbc++ +LIBODBCXX_VERSION = libodbc++-0.2.3 +XMLRPCXX_DIR = ${TOOLS_DIR}/xmlrpc++ +XMLRPCXX_VERSION = xmlrpc++-20040713 + +MODULES_DIR = ${BASE_DIR}/modules +CORE_DIR = ${MODULES_DIR}/core +DB_DIR = ${MODULES_DIR}/db +STORAGE_DIR = ${MODULES_DIR}/storage + +PRODUCTS_DIR = ${BASE_DIR}/products +SCHEDULER_DIR = ${PRODUCTS_DIR}/scheduler + #------------------------------------------------------------------------------- # Targets #------------------------------------------------------------------------------- -.PHONY: all doc clean docclean depclean distclean testresults +.PHONY: all doc clean docclean depclean distclean doxygen testresults +.PHONY: setup tools_setup modules_setup products_setup -all: doc +all: printusage -doc: +printusage: + ${ECHO} "LiveSupport project main Makefile" + ${ECHO} "http://livesupport.campware.org/" + ${ECHO} "Copyright (c) 2004 Media Development Loan Fund under the GNU GPL" + ${ECHO} "" + ${ECHO} "Useful targets for this makefile:" + ${ECHO} " setup - set up the development environment" + ${ECHO} " doc - build autogenerated documentation" + ${ECHO} " doxygen - build autogenerated doxygen documentation only" + +doc: doxygen testresults + +doxygen: ${DOXYGEN} ${DOXYGEN_CONFIG} testresults: @@ -65,3 +100,21 @@ testresults: clean: ${RMDIR} ${DOXYGEN_DIR}/html + +setup: tools_setup modules_setup products_setup + +tools_setup: + ${BOOST_DIR}/${BOOST_VERSION}/bin/install.sh + ${LIBXMLXX_DIR}/${LIBXMLXX_VERSION}/bin/install.sh + ${CXXUNIT_DIR}/${CXXUNIT_VERSION}/bin/install.sh + ${LIBODBCXX_DIR}/${LIBODBCXX_VERSION}/bin/install.sh + ${XMLRPCXX_DIR}/${XMLRPCXX_VERSION}/bin/install.sh + +modules_setup: + ${CORE_DIR}/bin/autogen.sh + ${DB_DIR}/bin/autogen.sh + ${STORAGE_DIR}/bin/autogen.sh + +products_setup: + ${SCHEDULER_DIR}/bin/autogen.sh + diff --git a/livesupport/doc/gettingStarted.html b/livesupport/doc/gettingStarted.html new file mode 100644 index 000000000..18343fcd8 --- /dev/null +++ b/livesupport/doc/gettingStarted.html @@ -0,0 +1,96 @@ + + + + + Getting started with the LiveSupport development environment + + + +

Preface

+This document is part of the LiveSupport +project, Copyright © 2004 Media +Development Loan Fund, under the GNU GPL.
+ +

Scope

+This document describes how to set up the LiveSupport development +environment.
+

Introduction

+LiveSupport uses a well-defined development environment. +Most of the LiveSupport-specific files are included in the version +control system, but some preparation and setup has to be made on system +used to develop LiveSupport as well.
+

Steps
+

+The following steps need to be taken for setting up the LiveSupport +development environment.
+ +

Set up additional system resources

+The LiveSupport development environment uses some system resources, +that are not reasonable to include in the environment itself. One such +resource is an ODBC datasource to a test database. This +database has to be accessible for executing the test suits and +applications within the LiveSupport development environment.
+
+More specifically, LiveSupport expects a PostgreSQL database, and an ODBC +Data Source accessible to it through unixODBC. +Please refer to the documentation of these tools to set them up.
+
+LiveSupport expects an ODBC Data Source with the following parameters:
+ +This data source should point to a PostgreSQL instance. Only one +developer at the time should access this datasource, as the test suites +regularly create and destroy database tables.
+

Check out the sources

+The LiveSupport development directory tree can be accessed via +anonymous CVS, using the +CVSROOT :pserver:anonymous@netfinity-5.mdlf.org/home/cvs. +The repository is called livesupport, thus the following CVS command +would check out the development tree:
+

cvs -z3 -d :pserver:anonymous@netfinity-5.mdlf.org/home/cvs checkout livesupport

+This will check out and create the LiveSupport development directory +structure.
+

Set up tools

+LiveSupport uses widely available tools for development, like the GNU +C++ compiler, but also uses more specific tools. As these tools, or the +exact versions of these tools are not expected to be installed on the +development system, the LiveSupport development environment contains +them. The tools are installed into the livesupport/usr +directory, as described in the directory structure document.
+
+Moreover, some components in livesupport have to be set up prior to +compilation, for example running autoconf or similar configuration +programs. This ensures that the components compile fine on the +development system.
+
+To achieve all these goals, invoke the target setup in +the main Makefile, at the root of the LiveSupport +directory structure, by issuing the following command in the +livesupport directory:
+

cd livesupport
make setup

+The execution of this command will take a while, as all the supporting +libraries and tools are compiled and installed to the livesupport/usr +directory. Please note that nothing is installed outside of the +LiveSupport directory structure.
+

Ready to roll

+With the above steps completed, the LiveSupport modules and products +are ready to be compiled and developed further. Have fun!
+
+
+ +