svn commit: r1214293 - /incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml

[kw...@apache.org]

Author: kwright
Date: Wed Dec 14 15:17:32 2011
New Revision: 1214293

URL: http://svn.apache.org/viewvc?rev=1214293&view=rev
Log:
Add multiprocess scripts to the build/deploy page

Modified:
    incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml

Modified: incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml?rev=1214293&r1=1214292&r2=1214293&view=diff
==============================================================================
--- incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml (original)
+++ incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml Wed Dec 14 15:17:32 2011
@@ -77,8 +77,8 @@
         <p>The output of the ant build is produced in the <em>dist</em> directory, which is further broken down by process.  (The number of produced <em>xxx-process</em> directories may vary, because optional individual connectors do sometimes supply processes that must be run to support the connector.)  See the table below for a description of the <em>dist</em> folder.</p>
         <p></p>
         <table>
-          <caption>Distribution directories</caption>
-          <tr><th><em>dist</em> directory</th><th>Meaning</th></tr>
+          <caption>Distribution directories and files</caption>
+          <tr><th><em>dist</em> file/directory</th><th>Meaning</th></tr>
           <tr><td><em>connectors.xml</em></td><td>an xml file describing the connectors that should be registered</td></tr>
           <tr><td><em>connector-lib</em></td><td>jars for all the connectors, referred to by properties.xml</td></tr>
           <tr><td><em>wsdd</em></td><td>wsdd files that are needed by the included connectors in order to function</td></tr>
@@ -90,7 +90,7 @@
           <tr><td><em>xxx-integration</em></td><td>pre-built integration components to deploy on target system "xxx", e.g. Solr</td></tr>
         </table>
         <p></p>
-        <p>For all of the <em>dist/xxx-process</em> subdirectories above, any scripts resulting from the build that pertain to that process will be placed in a <em>script</em> subdirectory.  Thus, the scripts for the <em>filenet-processes</em> subdirectory will be found in <em>dist/filenet-processes/script</em>.
+        <p>For all of the <em>dist/xxx-process</em> subdirectories above, any scripts resulting from the build that pertain to that process will be placed in a <em>script</em> subdirectory.  Thus, the scripts for the <em>filenet-process</em> subdirectory will be found in <em>dist/filenet-process/script</em>.
             The supplied scripts for a process generally take care of building an appropriate classpath and setting necessary -D switches.  (Note: none of the current connectors require special -D switches
             at this time.)  If you need to construct a classpath by hand, it is important to remember that "more" is not necessarily "better".  The process deployment strategy implied by the build structure has
             been carefully thought out to avoid jar conflicts.  Indeed, several connectors are structured using multiple processes precisely for that reason.</p>
@@ -105,14 +105,17 @@
             what you will find in this directory.</p>
         <p></p>
         <table>
-          <caption>Multiprocess example directories</caption>
-          <tr><th><em>dist/multiprocess-example</em> directory</th><th>Meaning</th></tr>
+          <caption>Multiprocess example files and directories</caption>
+          <tr><th><em>dist/multiprocess-example</em> file/directory</th><th>Meaning</th></tr>
           <tr><td><em>web</em></td><td>Web applications that should be deployed on tomcat or the equivalent, plus recommended application server -D switch names and values</td></tr>
           <tr><td><em>processes</em></td><td>classpath jars that should be included in the class path for all non-connector-specific processes, along with -D switches, using the same convention as described for tomcat, above</td></tr>
           <tr><td><em>properties.xml</em></td><td>an example ManifoldCF configuration file, in the right place for the multiprocess script to find it</td></tr>
           <tr><td><em>logging.ini</em></td><td>an example ManifoldCF logging configuration file, in the right place for the properties.xml to find it</td></tr>
           <tr><td><em>syncharea</em></td><td>an example ManifoldCF synchronization directory, which must be writable in order for multiprocess ManifoldCF to work</td></tr>
           <tr><td><em>logs</em></td><td>where the ManifoldCF logs get written to</td></tr>
+          <tr><td><em>start-agents[.sh|.bat]</em></td><td>script to start the agents process</td></tr>
+          <tr><td><em>stop-agents[.sh|.bat]</em></td><td>script to stop a running agents process cleanly</td></tr>
+          <tr><td><em>lock-clean[.sh|.bat]</em></td><td>script to clean up dirty locks (run only when all webapps and processes are stopped)</td></tr>
         </table>
         <p></p>
         <p>The basic multiprocess command scripts will be placed in the <em>processes/script</em> subdirectory.  The script for executing commands is <em>processes/script/executecommand[.sh|.bat]</em>.