[infinispan-commits] Infinispan SVN: r94 - trunk.

Tue Apr 7 12:27:43 EDT 2009

Author: manik.surtani at jboss.com
Date: 2009-04-07 12:27:43 -0400 (Tue, 07 Apr 2009)
New Revision: 94

Modified:
   trunk/README-Maven.txt
   trunk/README-i18n.txt
Log:


Modified: trunk/README-Maven.txt
===================================================================

--- trunk/README-Maven.txt	2009-04-07 14:04:10 UTC (rev 93)
+++ trunk/README-Maven.txt	2009-04-07 16:27:43 UTC (rev 94)
@@ -27,12 +27,10 @@
 
 * mvn package -P Docs: Packages the module as a JAR file, and builds the javadocs and user documentation from docbook sources.
 
-* mvn install: will install the artifacts in your local repo for use by other projects (such as JBoss Cache POJO edition
-  which depends on JBoss Cache Core).  Will also use Maven's assembly plugin to build ZIP files for download
-  (in target/distribution)
+* mvn install: will install the artifacts in your local repo for use by other projects.  Will also use Maven's assembly plugin to build ZIP files for download (in target/distribution)
 
 * mvn deploy: will build and deploy the project to the JBoss snapshots repository.  Note that you should have your WebDAV
-  username and password set up.  (Deploys snapshots to http://snapshots.jboss.org/maven2/org/jboss/cache/).  If you have
+  username and password set up.  (Deploys snapshots to http://snapshots.jboss.org/maven2/org/infinispan).  If you have
   a non-SNAPSHOT version number in your pom.xml, it will be deployed to the live releases repository (see below)
 
 * mvn clean site -Ptest-functional,codeCoverage: will run all tests in the test-functional profile and generate code
@@ -82,7 +80,7 @@
 1.4. Maven settings.xml
 -----------------------
 
-Working with the JBoss Cache source tree, I have configured my ~/.m2/settings.xml to look like:
+Working with the Infinispan source tree, I have configured my ~/.m2/settings.xml to look like:
 
 <settings>
 
@@ -119,13 +117,12 @@
 
 2.1. Current Groups
 -------------------
-* unit - Unit tests using stubs to isolate and test each major class in JBoss Cache.  This is the default group run if no test group is specified.
-* functional - Tests which test the general functionality of JBoss Cache
+* unit - Unit tests using stubs to isolate and test each major class in Infinispan.  This is the default group run if no test group is specified.
+* functional - Tests which test the general functionality of Infinispan
 * jgroups - Tests which need to send data on a JGroups Channel
 * transaction - Tests which use a transaction manager
 * profiling - Tests used for manual profiling, not meant for automated test runs
 * manual - Other tests that are run manually
-* integration - Integration tests emulating usage patterns for specific products such as JBoss AS Clustering and Hibernate clustering
 
 It should be noted that every test (except those not intended to be run by Hudson) should at least be in the functional
 group, since this is the default test group that is executed by maven, and the one that is required to prepare a release.
@@ -161,13 +158,13 @@
 Alternatively, if there is more than one test with a given classname in your test suite, you could provide the path to
 the test.
 
-   $ mvn -P test-XXX -Dtest=org/jboss/cache/multiplexer/SyncReplTxTest test
+   $ mvn -P test-XXX -Dtest=org/infinispan/api/MixedModeTest test
 
 2.5. Executing all tests in a given package
 --------------------------------------------
 This can be achieved by passing in the package name with a wildcard to the test parameter.
 
-   $ mvn -P test-XXX -Dtest=org/jboss/cache/multiplexer/* test
+   $ mvn -P test-XXX -Dtest=org/infinispan/api/* test
 
 2.6. Skipping the test run
 --------------------------
@@ -207,7 +204,7 @@
 
 Or, to use JBoss JTA (Arjuna TM) instead of the DummyTransactionManager in a "transaction" group test, set:
 
-   -Dorg.jboss.cache.test.tm=jboss-jta
+   -Dorg.infinispan.test.tm=jboss-jta
 
 Please refer to the POM file for more properties and permutations.
 

Modified: trunk/README-i18n.txt
===================================================================
--- trunk/README-i18n.txt	2009-04-07 14:04:10 UTC (rev 93)
+++ trunk/README-i18n.txt	2009-04-07 16:27:43 UTC (rev 94)
@@ -1,28 +1,7 @@
 Internationalising documentation
 --------------------------------
 
-Documentation for JBoss Cache is written using docbook XML.  There is a lot of reference material on docbook XML if
-you are unfamiliar with it, but JBoss Cache's usage of docbook is pretty basic and most of it can be picked up by looking
-through the existing documentation sources, which are in src/main/docbook.
+Documentation for Infinispan is maintained on the JBoss.org content management system.
 
-For each document, the 'en' version is treated as the reference source for all translations.
+If you are interested in contributing a translation of the documentation, please get in touch with the Infinispan development team.  Details on how to do so are on http://www.jboss.org/infinispan/community
 
-Starting a new translation
---------------------------
-
-** NB: This section needs updating since moving to subversion.
-
-Each time a new translation is started, the docs directory should be updated and tagged as I18N_<2-letter iso lang code>_<2-letter iso country code> (optional)
-such as I18N_IT or I18N_PT_BR (note all in upper case)
-
-Updating translations
----------------------
-
-Each time a new release is made, translations should be updated by:
-
-1) Doing a diff of the 'en' docs, comparing the latest against the translation tag (e.g., I18N_IT)
-2) Updating the translation (e.g., the 'it' docs)
-3) Moving the translation tag on the 'en' files (e.g., I18N_IT) to the current snapshot.
-
-- Manik Surtani
-


