[jboss-cvs] JBoss Messaging SVN: r7062 - in trunk/docs: diagrams and 2 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed May 27 05:25:35 EDT 2009
Author: timfox
Date: 2009-05-27 05:25:34 -0400 (Wed, 27 May 2009)
New Revision: 7062
Added:
trunk/docs/diagrams/
trunk/docs/diagrams/standard_image.odg
Removed:
trunk/docs/standard_image.odg
Modified:
trunk/docs/quickstart-guide/en/download.xml
trunk/docs/quickstart-guide/en/examples.xml
trunk/docs/quickstart-guide/en/installation.xml
trunk/docs/quickstart-guide/en/introduction.xml
trunk/docs/user-manual/en/client-classpath.xml
trunk/docs/user-manual/en/libaio.xml
Log:
more tweaks to docs
Copied: trunk/docs/diagrams/standard_image.odg (from rev 7059, trunk/docs/standard_image.odg)
===================================================================
(Binary files differ)
Modified: trunk/docs/quickstart-guide/en/download.xml
===================================================================
--- trunk/docs/quickstart-guide/en/download.xml 2009-05-27 08:11:39 UTC (rev 7061)
+++ trunk/docs/quickstart-guide/en/download.xml 2009-05-27 09:25:34 UTC (rev 7062)
@@ -12,15 +12,15 @@
</section>
<section id="download.svn">
- <title>SVN Repository</title>
- <para>You can checkout the development version of JBoss Messaging directly from its
- Subversion repository. Be aware that the
- information provided in this manual might then not be accurate. For the
- latest instructions on how to check out and build source code, please go
- to <ulink
- url="http://wiki.jboss.org/wiki/JBossMessagingDevelopment">
- Messaging Development Wiki</ulink>, and specifically <ulink
- url="http://wiki.jboss.org/wiki/JBossMessagingBuildInstructions">
- Building and Running JBoss Messaging</ulink> page.</para>
+ <title>Project Information</title>
+ <para>If you have any user questions please use our <ulink
+ url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=238">user
+ forum</ulink></para>
+ <para>If you have development related questions, please use our <ulink
+ url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=153">development
+ forum</ulink></para>
+ <para>Pop in and chat to us in our <ulink url="irc://irc.freenode.net:6667/jbossmessaging">IRC channel</ulink></para>
+ <para>JBoss Messaging Subversion TRUNK is <ulink url="http://anonsvn.jboss.org/repos/messaging/trunk">here</ulink></para>
+ <para>All our release tags are <ulink url="http://anonsvn.jboss.org/repos/messaging/tags">here</ulink></para>
</section>
</chapter>
\ No newline at end of file
Modified: trunk/docs/quickstart-guide/en/examples.xml
===================================================================
--- trunk/docs/quickstart-guide/en/examples.xml 2009-05-27 08:11:39 UTC (rev 7061)
+++ trunk/docs/quickstart-guide/en/examples.xml 2009-05-27 09:25:34 UTC (rev 7062)
@@ -4,37 +4,40 @@
<para>In the directory <literal>examples</literal> there are 2 sets of examples, these are </para>
<itemizedlist>
<listitem>
- <para>JMS Examples</para>
+ <para>JMS Examples - these demonstrate functionality by sending and consuming JMS
+ messages.</para>
</listitem>
<listitem>
- <para>Java EE Examples</para>
+ <para>Java EE Examples - these demonstrate app server integration, e.g. MDBs, EJBs,
+ Servlets etc</para>
</listitem>
</itemizedlist>
- <para>All the examples are run using Ant.</para>
+ <para>All the examples are run using ant. You will need ant installed on your system and the ant
+ <literal>bin</literal> directory on your path.</para>
<section id="examples.jms">
<title>The JMS examples</title>
<para>The JMS Examples all follow the same format. Each examples is contained in its own
directory which contains the following.</para>
<itemizedlist>
<listitem>
- <para>build.xml</para>
+ <para><literal>build.xml</literal></para>
<para>This is the ant build file used to run the example</para>
</listitem>
<listitem>
- <para>src directory</para>
+ <para><literal>src</literal> directory</para>
<para>This contains the source code for the example</para>
</listitem>
<listitem>
- <para>server0 config dir</para>
+ <para><literal>server0</literal> config directory</para>
<para>This contains the configuration files needed to run the server for the example.
- There may be multiple config directories server0, server1 etc for clustered examples
- etc.</para>
+ There may be multiple config directories <literal>server0</literal>, <literal
+ >server1</literal> etc for clustered examples etc.</para>
</listitem>
</itemizedlist>
- <para>Each example will start 1 or more standalone servers and stop them after the example has
- completed.</para>
+ <para>Each example will start one or more standalone servers and stop them after the example
+ has completed.</para>
<para>As a quick start we'll run the queue example. For all other examples refer to the main
- User Manual.</para>
+ user manual.</para>
<para>Firstly open a Shell or a Command prompt and navigate to the <literal
>examples/jms/queue</literal> directory.</para>
<para>Type the command <literal>ant</literal> and you should see the following output:</para>
Modified: trunk/docs/quickstart-guide/en/installation.xml
===================================================================
--- trunk/docs/quickstart-guide/en/installation.xml 2009-05-27 08:11:39 UTC (rev 7061)
+++ trunk/docs/quickstart-guide/en/installation.xml 2009-05-27 09:25:34 UTC (rev 7062)
@@ -5,7 +5,8 @@
<section id="installation.prerequisites">
<title>Prerequisites</title>
<note>
- <para>JBoss Messaging only runs on Java 5 or later.</para>
+ <para>JBoss Messaging only runs on Java 5 or later. We highly recommend you use Java
+ 6.</para>
</note>
<para>By default, JBoss Messaging server is run with 1GB of memory. If your computer has less
memory, modify the value in <literal>bin/run.sh</literal> accordingly.</para>
Modified: trunk/docs/quickstart-guide/en/introduction.xml
===================================================================
--- trunk/docs/quickstart-guide/en/introduction.xml 2009-05-27 08:11:39 UTC (rev 7061)
+++ trunk/docs/quickstart-guide/en/introduction.xml 2009-05-27 09:25:34 UTC (rev 7062)
@@ -1,7 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="introduction">
- <title>Introduction</title>
- <para>This guide will help you to download, install and run JBoss Messaging. It will also get
- you started by running some examples. For more in depth information use the JBoss Messaging
- User Guide.</para>
+ <title>Getting Started</title>
+ <para>This short guide explains how to download, install and quickly get started with JBoss
+ Messaging.</para>
+ <para>After downloading and installing we highly recommend you run the examples to get
+ acquainted with JBoss Messaging. We ship with over 50 examples demonstrating most of the
+ features.</para>
+ <para>This guide is not intended to be a replacement for the user manual. The user manual goes
+ into much more depth, so please consult that for further information.</para>
</chapter>
Deleted: trunk/docs/standard_image.odg
===================================================================
(Binary files differ)
Modified: trunk/docs/user-manual/en/client-classpath.xml
===================================================================
--- trunk/docs/user-manual/en/client-classpath.xml 2009-05-27 08:11:39 UTC (rev 7061)
+++ trunk/docs/user-manual/en/client-classpath.xml 2009-05-27 09:25:34 UTC (rev 7062)
@@ -1,13 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="client-classpath">
<title>The Client Classpath</title>
- <para>In this chapter we explain what jars you need on the Java classpath of a JBoss Messaging
+ <para>In this chapter we explain which jars you need on the Java classpath of a JBoss Messaging
client application. This depends on various factors including whether you're using just
- core, JMS, JNDI or Netty. We explain what jars are needed in each case.</para>
- <note><para>All the jars mentioned here can be found in the <literal>lib</literal> directory of
+ core, JMS, JNDI or Netty. We explain which jars are needed in each case.</para>
+ <note>
+ <para>All the jars mentioned here can be found in the <literal>lib</literal> directory of
the JBoss Messaging distribution. Be sure you only use the jars from the correct version
of the release, you <emphasis>must not</emphasis> mix and match versions of jars from
- different JBoss Messaging versions.</para></note>
+ different JBoss Messaging versions.</para>
+ </note>
<section>
<title>Pure Core Client</title>
<para>If you're using just a pure JBoss Messaging core client (i.e. no JMS) then you need
Modified: trunk/docs/user-manual/en/libaio.xml
===================================================================
--- trunk/docs/user-manual/en/libaio.xml 2009-05-27 08:11:39 UTC (rev 7061)
+++ trunk/docs/user-manual/en/libaio.xml 2009-05-27 09:25:34 UTC (rev 7062)
@@ -3,9 +3,10 @@
<title>Libaio Native Libraries</title>
<para>JBoss Messaging distributes a native library, used as a bridge between JBoss Messaging and
linux libaio.</para>
- <para>libaio is a library, developed as part of the linux kernel project. With libaio we perform
- writes directly on the operation system, and the kernel will send a callback events being a
- much faster approach than traditional syncs used on committs.</para>
+ <para><literal>libaio</literal> is a library, developed as part of the linux kernel project.
+ With <literal>libaio</literal> we submit writes to the operating system where they are
+ processed asynchronously. Some time later the OS will call our code back when they have been
+ processed.</para>
<para>The native library is distributed in two flavors:</para>
<itemizedlist>
<listitem>
@@ -19,8 +20,9 @@
on the <link linkend="using-server.library.path">library path</link>.</para>
<section>
<title>Compiling the native libraries</title>
- <para>Case you are using Linux on a platform other than x86_32 and x86_64 you may need to
- compile the native library.</para>
+ <para>Case you are using Linux on a platform other than x86_32 and x86_64, e.g. IA64
+ (Itanium) or IBM POWER, you may need to compile the native library, since we do not
+ distribute binaries for those platforms with the release.</para>
<section>
<title>Install requirements</title>
<para>The native library uses <ulink url="http://en.wikipedia.org/wiki/Autoconf"
More information about the jboss-cvs-commits
mailing list