[jboss-cvs] JBossAS SVN: r85985 - in projects/jboss-jca/trunk/doc: developerguide and 2 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Tue Mar 17 09:51:19 EDT 2009
Author: jesper.pedersen
Date: 2009-03-17 09:51:19 -0400 (Tue, 17 Mar 2009)
New Revision: 85985
Added:
projects/jboss-jca/trunk/doc/developerguide/
projects/jboss-jca/trunk/doc/developerguide/build.xml
projects/jboss-jca/trunk/doc/developerguide/en/
projects/jboss-jca/trunk/doc/developerguide/en/images/
projects/jboss-jca/trunk/doc/developerguide/en/master.xml
projects/jboss-jca/trunk/doc/developerguide/en/modules/
projects/jboss-jca/trunk/doc/developerguide/en/modules/about.xml
projects/jboss-jca/trunk/doc/developerguide/en/modules/building.xml
projects/jboss-jca/trunk/doc/developerguide/en/modules/metadata.xml
projects/jboss-jca/trunk/doc/developerguide/en/modules/testing.xml
Log:
First pass of the developer guide
Added: projects/jboss-jca/trunk/doc/developerguide/build.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/build.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/developerguide/build.xml 2009-03-17 13:51:19 UTC (rev 85985)
@@ -0,0 +1,17 @@
+<project name="developerguide" default="all" basedir=".">
+
+ <property name="build.dir" value="${basedir}/../../target/docs/developerguide"/>
+ <property name="pdf.name" value="JBossJCADeveloperGuide.pdf"/>
+ <import file="${basedir}/../../tools/docbook/support.xml"/>
+
+ <target name="all" depends="clean">
+ <mkdir dir="en/images" />
+ <antcall target="lang.all"><param name="lang" value="en"/></antcall>
+ </target>
+
+ <target name="html.doc" description="creates the html docs only and opens a browser">
+ <mkdir dir="en/images" />
+ <antcall target="lang.dochtml"><param name="lang" value="en"/></antcall>
+ </target>
+
+</project>
Added: projects/jboss-jca/trunk/doc/developerguide/en/master.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/master.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/developerguide/en/master.xml 2009-03-17 13:51:19 UTC (rev 85985)
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN"
+ "../../../tools/docbook/support/docbook-dtd/docbookx.dtd" [
+ <!ENTITY about SYSTEM "modules/about.xml">
+ <!ENTITY building SYSTEM "modules/building.xml">
+ <!ENTITY testing SYSTEM "modules/testing.xml">
+ <!ENTITY metadata SYSTEM "modules/metadata.xml">
+ ]>
+<book lang="en">
+ <bookinfo>
+ <title>JBoss JCA 1.0 Developer's Guide</title>
+
+ <subtitle>Connecting your Enterprise Information Systems</subtitle>
+
+ </bookinfo>
+
+ <toc></toc>
+
+ &about;
+
+ &building;
+
+ &testing;
+
+ &metadata;
+
+</book>
Added: projects/jboss-jca/trunk/doc/developerguide/en/modules/about.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/about.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/about.xml 2009-03-17 13:51:19 UTC (rev 85985)
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="about">
+ <title>About JBoss JCA</title>
+</chapter>
Added: projects/jboss-jca/trunk/doc/developerguide/en/modules/building.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/building.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/building.xml 2009-03-17 13:51:19 UTC (rev 85985)
@@ -0,0 +1,130 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="building">
+ <title>Building</title>
+
+ <section id="prerequisites">
+ <title>Prerequisites</title>
+
+ <section id="jdk">
+ <title>Java Development Kit (JDK)</title>
+ <para>You must have one of the following JDKs installed in order to build the project:</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Sun JDK 1.5.x</para>
+ </listitem>
+ <listitem>
+ <para>Sun JDK 1.6.x</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Remember to ensure that "javac" and "java" are in your path (or symlinked).</para>
+
+ <programlisting>
+JAVA_HOME=/location/to/javahome
+export JAVA_HOME
+
+PATH=$JAVA_HOME/bin:$PATH
+export PATH
+ </programlisting>
+
+ </section>
+
+ <section id="ant">
+ <title>Apache Ant</title>
+ <para>You must have Apache Ant 1.7.1+ installed on your system.</para>
+ <para>Remember to ensure that "ant" are in your path (or symlinked).</para>
+
+ <programlisting>
+ANT_HOME=/location/to/anthome
+export ANT_HOME
+
+PATH=$ANT_HOME/bin:$PATH
+export PATH
+ </programlisting>
+
+ </section>
+
+ <section id="ivy">
+ <title>Apache Ivy</title>
+ <para>You must have Apache Ivy 2.0.0+ installed in your Apache Ant installation.</para>
+
+ <programlisting>
+cp ivy.jar $ANT_HOME/lib
+ </programlisting>
+
+ </section>
+
+ <section id="subversion">
+ <title>Subversion</title>
+ <para>You must have Subversion 1.5+ installed on your system.</para>
+ <para>Remember to ensure that "svn" are in your path (or symlinked).</para>
+ </section>
+
+ </section>
+
+ <section id="obtainingthesource">
+ <title>Obtaining the source code</title>
+
+ <section id="anonsvn">
+ <title>Anonymous SVN access</title>
+ <para>The anonymous SVN repository is located under:</para>
+
+ <programlisting>
+svn co http://anonsvn.jboss.org/repos/jbossas/projects/jboss-jca/trunk/ jbossjca-trunk
+ </programlisting>
+
+ </section>
+
+ <section id="developersvn">
+ <title>Developer SVN access</title>
+ <para>The developer SVN repository is located under:</para>
+
+ <programlisting>
+svn co https://svn.jboss.org/repos/jbossas/projects/jboss-jca/trunk/ jbossjca-trunk
+ </programlisting>
+
+ </section>
+
+ <section id="svnmodules">
+ <title>SVN modules</title>
+ <para>We have the following modules for the project:</para>
+ <itemizedlist>
+ <listitem>
+ <para>trunk</para>
+ <para>The head of development targeting the next upcoming release.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ </section>
+
+ <section id="compiling">
+ <title>Compiling the source code</title>
+ <para>In order to build the JBoss JCA project you execute:</para>
+ <programlisting>
+ant <target>
+ </programlisting>
+ <para>where target is one of</para>
+ <itemizedlist>
+ <listitem>
+ <para>jars</para>
+ <para>Builds the JAR archives in the distribution.</para>
+ </listitem>
+ <listitem>
+ <para>test</para>
+ <para>Builds the JAR archives in the distribution and runs all the test cases.</para>
+ </listitem>
+ <listitem>
+ <para>docs</para>
+ <para>Builds the API documentation for the project.</para>
+ </listitem>
+ <listitem>
+ <para>clean</para>
+ <para>Cleans the project of temporary files.</para>
+ </listitem>
+ </itemizedlist>
+ <para>See the full list of targets in the main build.xml file.</para>
+
+ </section>
+</chapter>
Added: projects/jboss-jca/trunk/doc/developerguide/en/modules/metadata.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/metadata.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/metadata.xml 2009-03-17 13:51:19 UTC (rev 85985)
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="metadata">
+ <title>Metadata</title>
+</chapter>
Added: projects/jboss-jca/trunk/doc/developerguide/en/modules/testing.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/testing.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/testing.xml 2009-03-17 13:51:19 UTC (rev 85985)
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="testing">
+ <title>Testing</title>
+
+</chapter>
More information about the jboss-cvs-commits
mailing list