You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by or...@apache.org on 2017/11/02 14:28:17 UTC
qpid-broker-j git commit: QPID-7985: [Documentation] Update README.md
Repository: qpid-broker-j
Updated Branches:
refs/heads/master 7a406d501 -> 1b7892ce3
QPID-7985: [Documentation] Update README.md
Project: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/commit/1b7892ce
Tree: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/tree/1b7892ce
Diff: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/diff/1b7892ce
Branch: refs/heads/master
Commit: 1b7892ce316e84100d85dfdbbdc60bb7865b4424
Parents: 7a406d5
Author: Alex Rudyy <or...@apache.org>
Authored: Thu Nov 2 14:27:30 2017 +0000
Committer: Alex Rudyy <or...@apache.org>
Committed: Thu Nov 2 14:27:30 2017 +0000
----------------------------------------------------------------------
README.md | 44 ++++++++++++++++++++++++--------------------
1 file changed, 24 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/1b7892ce/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 0bfb188..78e556a 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,13 @@
# Apache Qpid Broker-J
-The Apache Qpid Broker-J (Broker-J) is a powerful open-source message broker.
+The Apache Qpid Broker-J is a powerful open-source message broker.
-* Supports Advanced Message Queuing Protocol (AMQP) versions 0-8, 0-9, 0-91, 0-10 and AMQP 1.0
-* 100% Java implementation.
+* Supports Advanced Message Queuing Protocol (AMQP) versions 0-8, 0-9, 0-91, 0-10 and 1.0
+* 100% Java implementation
* Authentication options include for LDAP, Kerberos, O-AUTH2, TLS client-authentication and more
-* Message storage options include Apache Derby, Oracle BDB JE, and Generic JDBC.
-* Web-management console.
+* Message storage options include Apache Derby, Oracle BDB JE, and Generic JDBC
+* REST and AMQP 1.0 management API
+* Web-management console
* Plug-able architecture
Below are some quick pointers you might find useful.
@@ -25,31 +26,34 @@ Install all modules to the local repository after running all the tests:
## Running the tests
-Maven profiles are used to set the test configuration. If no profile is explicitly selected, *java-mms-1.0* is activated
-by default.
+Maven profiles are used to run tests for the supported protocols and storage options.
+Profile names follow the form *java-store.n-n*, where
+ *store* signifies the storage module and
+ *n-n* the AMQP protocol version number.
- mvn verify
-
-To see all the available profiles.
-
- mvn help:all-profiles
-
-Profiles whose name follows the form *java-store.n-n* are test configuration profiles. *store* signifies the storage
-module and *n-n* the AMQP protocol version number. For store, the options include:
+For store, the options include:
* *bdb* - Oracle BDB JE
* *dby* - Apache Derby
* *mms* - an in-memory store principally used for testing.
-For example, to activate a BDB with AMQP 1.0 protocol use:
+If no profile is explicitly selected, *java-mms-1.0* is activated by default.
+
+ mvn verify
+
+To activate a BDB with AMQP 1.0 protocol use:
mvn verify -P java-bdb.1-0
+To see all the available profiles.
+
+ mvn help:all-profiles
+
When activating AMQP 0-8..0-10 profiles, it is also necessary to pass the system property *-DenableAmqp0-x*
- mvn verify -P java-dby.1-0 -DenableAmqp0-x
+ mvn verify -P java-dby.0-9-1 -DenableAmqp0-x
-Perform a subset tests on the packaged release artifacts without installing:
+Perform a subset of tests on the packaged release artifacts without installing:
mvn verify -Dtest=TestNamePattern* -DfailIfNoTests=false
@@ -59,7 +63,7 @@ Execute the tests and produce code coverage report:
## Documentation
-Documentation (in docbook format) is found beneath the *doc* module. The documentation is available in a published
+Documentation (in docbook format) is found beneath the *doc* module. The documentation is available in a published
form at:
http://qpid.apache.org/documentation.html
@@ -67,7 +71,7 @@ http://qpid.apache.org/documentation.html
## Distribution assemblies
-After packaging, Broker-J distribution distribution assemblies can be found at:
+After packaging, the broker distribution assemblies can be found at:
broker/target
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org