avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From je...@apache.org
Subject cvs commit: jakarta-avalon-excalibur README.txt
Date Wed, 08 May 2002 11:12:05 GMT
jefft       02/05/08 04:12:05

  Modified:    .        README.txt
  Log:
  Reorganize README, removing obsolete refs to all/, adding info on debugging
  build failures, and adding a section on the project's relation to Commons
  
  Revision  Changes    Path
  1.8       +51 -56    jakarta-avalon-excalibur/README.txt
  
  Index: README.txt
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/README.txt,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- README.txt	13 Apr 2002 10:04:31 -0000	1.7
  +++ README.txt	8 May 2002 11:12:05 -0000	1.8
  @@ -4,85 +4,80 @@
     What is it?
     -----------
   
  -  Excalibur is a collection of often-needed reusable components. It includes tools for
  -  threading, pooling, datasources, command-line interface (CLI) option parsing
  -  and more.
  +  Excalibur is a collection of often-needed reusable components. It includes
  +  tools for threading, pooling, datasources, command-line interface (CLI)
  +  option parsing and more.
   
     Where is it?
     ------------
   
     http://jakarta.apache.org/avalon
   
  -  Directory Layout
  -  ----------------
   
  -  Excalibur is comprised of a number reusable components. These components are
  -  what you see in most of the subdirectories.
  +  General Building Requirements
  +  -----------------------------
   
  -  The all/ directory contains a core set of packages that cannot be
  -  componentized further (excalibur-core.jar). It is a legacy of a time before
  -  Excalibur was componentized, and as such, it's build system has much
  -  functionality not yet present elsewhere. In time, functionality in
  -  all/build.xml will migrate to ./build.xml.
  -
  -  The avalon-excalibur.jar released in version 4.1 would now consist of the
  -  following jars:
  -
  -   all/build/lib/avalon-excalibur.jar
  -   datasource/build/lib/excalibur-datasource-1.0.jar
  -   cli/build/lib/excalibur-cli-1.0.jar
  -   collections/build/lib/excalibur-collections-1.0.jar
  -   concurrent/build/lib/excalibur-concurrent-1.0.jar
  -   component/build/lib/excalibur-component-1.0.jar
  -   i18n/build/lib/excalibur-i18n-1.0.jar
  -   io/build/lib/excalibur-io-1.0.jar
  -   naming/build/lib/excalibur-naming-1.0.jar
  -   logger/build/lib/excalibur-logger-1.0.jar
  -   pool/build/lib/excalibur-pool-1.0.jar
  -   testcase/build/lib/excalibur-testcase-1.0.jar
  -   util/build/lib/excalibur-util-1.0.jar
  +  - JDK 1.2 or above
  +  - Jakarta Ant 1.4.1 or higher, with optional.jar and junit.jar in $ANT_HOME/lib
  +  - To build from CVS you must set JAVA_HOME to the jdk dir (eg:/usr/bin/jdk1.2
  +    or c:\jdk1.3)
  +  - To build Informix drivers you need version 2.2 of the JDBC driver
  +  - To build J2EE client for connections you need JNDI and the JDBC extensions
   
  -   in addition, versions post-4.1 have a dependency on:
   
  -   instrument/build/lib/excalibur-instrument-0.1.jar
  +  Getting Started
  +  ---------------
   
  -   Typing 'ant' in the root directory will build an avalon-excalibur.jar
  -   containing these components.
  +  Excalibur is comprised of a number of subprojects. These subprojects are what
  +  you see in most of the subdirectories. They can be built individually, by
  +  running 'ant' in the subproject directory. If the subproject depends on other
  +  subprojects, these will be automatically (recursively) built.
  +
  +  Alternatively if you type 'ant' in the project root, a file
  +  'avalon-excalibur.jar' will be built, containing an internally consistent set
  +  of components historically regarded as comprising 'Excalibur'.
   
   
     Component dependencies
     ----------------------
   
  -  Each component may have dependencies on external jars, and on other
  -  components. These dependencies are listed in the ant.properties.sample files
  -  in the root of each component. You may need to customize these properties for
  -  your local environment. See the text in ant.properties.sample for more
  -  information.
  +  Each component may have dependencies on other Avalon jars (typically Avalon
  +  Framework and LogKit), external jars, and on other components. These
  +  dependencies are listed in the ant.properties.sample files in the root of
  +  each component. You may need to customize these properties for your local
  +  environment. See the text in ant.properties.sample for more information.
   
     In general, it is safe to type 'ant', and if an external dependency is
     missing, you will be prompted on what to add to ant.properties. If instead
  -  you get compiler errors, please let us know: it is a bug in the build system.
  +  you get compiler errors, the course of action you should take is as follows:
   
  +  - If building from CVS, make sure you have the latest code, with no local
  +    modifications. Always do 'cvs update -d' to get added directories.
  +  - Do an 'ant clean', and try again.
  +  - Make sure your CLASSPATH variable is empty (preferably), or at least
  +    doesn't contain any Avalon/Excalibur jars. On Windows, check this by typing
  +    'echo %CLASSPATH%' at a DOS prompt; on Unix, it's 'echo ${CLASSPATH}'.
  +  - If you're using jikes (Ant property build.compiler=jikes), try switching to
  +    Sun's javac. While generally better, certain versions of jikes have been
  +    known to cause odd problems.
  +  - If nothing helped, let us know! It might be a bug in the build system.
  +    Please include the Ant log messages in your mail. The output of 'ant -v' is
  +    also sometimes useful for debugging.
   
  -  General Building Requirements
  -  -----------------------------
   
  -  -JDK1.2 or above
  -  -Jakarta Ant 1.4.1 or higher, with optional.jar and junit.jar in $ANT_HOME/lib
  -  -To build from CVS you must set JAVA_HOME to the jdk dir (eg:/usr/bin/jdk1.2 or
  -   c:\jdk1.3)
  -  -To build Informix drivers you need version 2.2 of the JDBC driver
  -  -To build J2EE client for connections you need JNDI and the JDBC extensions
  -
  -
  -  Getting Started
  -  ---------------
  +  Relation with Jakarta Commons
  +  -----------------------------
   
  -  Generally, one would build individual components, not the whole of Excalibur.
  -  This can be done by typing 'ant' in any component's directory.
  -  However, if you type 'ant' in the project root, a file 'avalon-excalibur.jar'
  -  will be built, containing a set of components historically regarded as
  -  comprising 'Excalibur'.
  +  Users are encouraged to take a look at the Jakarta Commons project
  +  (http://jakarta.apache.org/commons/), another part of Jakarta dedicated to
  +  producing quality reusable software. There are many functional overlaps
  +  between Commons and Excalibur. The primary difference is that Excalibur
  +  components are designed to fit in well with the Avalon Framework--in many
  +  cases implementing Framework interfaces--and generally applying the
  +  principles of SoC and IoC (see the website). Combine this philosophical
  +  difference with some minor disputes on project organization, and you have the
  +  current situation. In time, we hope to make the distinction between Commons
  +  and Exclibur much less prominent.
   
   
     Problems?
  
  
  

--
To unsubscribe, e-mail:   <mailto:avalon-cvs-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@jakarta.apache.org>


Mime
View raw message