[jboss-cvs] JBoss Messaging SVN: r4351 - trunk/docs/userguide/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Fri May 30 09:36:15 EDT 2008
Author: jmesnil
Date: 2008-05-30 09:36:15 -0400 (Fri, 30 May 2008)
New Revision: 4351
Modified:
trunk/docs/userguide/en/modules/installation.xml
trunk/docs/userguide/en/modules/journal.xml
trunk/docs/userguide/en/modules/runningexamples.xml
Log:
added a prerequisites section in installation.xml
typo + cosmetic changes
Modified: trunk/docs/userguide/en/modules/installation.xml
===================================================================
--- trunk/docs/userguide/en/modules/installation.xml 2008-05-30 10:21:50 UTC (rev 4350)
+++ trunk/docs/userguide/en/modules/installation.xml 2008-05-30 13:36:15 UTC (rev 4351)
@@ -1,9 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="installation">
<title>JBoss Messaging Installation</title>
- <para>This section describes procedures on how to install JBoss Messaging both standalone and within JBoss AS 5
+ <para>This section describes the prerequisites and procedures to install JBoss Messaging.
</para>
+ <section id="installation.prerequisites">
+ <title>Prerequisites</title>
+ <para><note>JBoss Messaging only runs with Java 5 or later.</note></para>
+ <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>
+ <para><ulink url="http://ant.apache.org/">Ant</ulink> is required to build and run the examples.</para>
+ </section>
+
<section id="installation.standalone">
<title>Installing JBoss Messaging standalone</title>
<para>After downloading the distribution unzip it into your chosen directory. At this point it should be possible
Modified: trunk/docs/userguide/en/modules/journal.xml
===================================================================
--- trunk/docs/userguide/en/modules/journal.xml 2008-05-30 10:21:50 UTC (rev 4350)
+++ trunk/docs/userguide/en/modules/journal.xml 2008-05-30 13:36:15 UTC (rev 4351)
@@ -6,15 +6,15 @@
<para>If you are using JBoss Messaging 2 on a Linux system, you can take full advantage of this feature. All you
have to do is to make sure libaio is installed and you are using ext3 or ext2 or newer kernels.
</para>
- <para>to install libaio on Fedora or Red Hat run the command 'yum install libaio' or on Ubuntu run either 'sudo
- apt-get install libaio' or 'aptitude install libaio1'. For other OS's refer to the OS manual.
+ <para>To install libaio, run the command <literal>yum install libaio</literal> on Fedora or Red Hat or <literal>sudo
+ apt-get install libaio</literal> on Ubuntu or Debian. For other OS's refer to the OS manual.
</para>
<para>Instead of synchronizing the whole disk on every commit required by the journal, We submit writes directly
to the kernel and we get callbacks when the information is stored on the hard drive. With that
we maximize performance by isolating the persistnce of one transaction from another and also by using Direct
Memory Access between the Journal and the Kernel. With AIO you can have high rate transactions even when you
commit several small transactions.
- We are planing migrating this native liraries to other platforms besides Linux, as other OS's will have
+ We are planning migrating this native lirary to other platforms besides Linux, as other OS's will have
different options for Asynchronous IO.
</para>
</section>
@@ -27,10 +27,11 @@
</section>
<section id="journal.jdbc">
<title>JDBC</title>
- <para>We are not supporting any JDBC mapping on JBoss Messaging 2 Alpha. JDBC is planned for Beta for users that
- require a database for management purposes.
- We will of course optimize JDBC access but we won't expect a lot of performance for persistent messages on JDBC
- as a relational database wasn't designed to the demand levels required by a Messaging System.
+ <para>JDBC mapping is not supported for the Alpha release of JBoss Messaging 2.</para>
+ <para>It is planned for the Beta release for users that require a database for management purposes.
+ JDBC access will be optimized but it is not expected to reach the same level of performance for persistent
+ messages than the ASYNCIO and NIO implementations as a relational database is not designed to meet the requirements
+ of a Messaging System.
</para>
</section>
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/modules/runningexamples.xml
===================================================================
--- trunk/docs/userguide/en/modules/runningexamples.xml 2008-05-30 10:21:50 UTC (rev 4350)
+++ trunk/docs/userguide/en/modules/runningexamples.xml 2008-05-30 13:36:15 UTC (rev 4351)
@@ -23,14 +23,14 @@
<para>For each example, you can always override the default ports it will
try to connect to by editing jndi.properties in the config directory
</para>
- <para>to run a specific example open up a shell or command prompt and navigate into the
+ <para>To run a specific example open up a shell or command prompt and navigate into the
<literal>examples/jms</literal>
directory and run the command ant followed by the example name, as follows
</para>
<programlisting>
ant queueExample
</programlisting>
- <para>The output should be similar top the following</para>
+ <para>The output should be similar to the following</para>
<programlisting>
Buildfile: build.xml
@@ -174,12 +174,13 @@
<para>SSLClient</para>
<para>This example shows a simple send and receive to a remote queue using SS. The server will need to be
running and configured to use SSL for this example. Refer to the configuration chapter for details on how
- to do this
+ to do this.
</para>
</listitem>
<listitem>
<para>simpleExample</para>
- <para>This example shows how to create an embedded JBM server using the core API.
+ <para>This example shows how to create an embedded JBM server using the core API. The server must not have
+ been started before running this example.
</para>
</listitem>
</itemizedlist>
More information about the jboss-cvs-commits
mailing list