[C-MPI-commits] SF.net SVN: c-mpi:[126] docs/manual/manual.xml

[<jmw...@us...>]

Revision: 126
          http://c-mpi.svn.sourceforge.net/c-mpi/?rev=126&view=rev
Author:   jmwozniak
Date:     2010-05-14 21:00:15 +0000 (Fri, 14 May 2010)

Log Message:
-----------
Add notes about C-MPI modes

Modified Paths:
--------------
    docs/manual/manual.xml

Modified: docs/manual/manual.xml
===================================================================
--- docs/manual/manual.xml	2010-05-14 20:44:21 UTC (rev 125)
+++ docs/manual/manual.xml	2010-05-14 21:00:15 UTC (rev 126)
@@ -511,6 +511,27 @@
 		  </variablelist>
 		</para></listitem>
 	      </varlistentry>
+              <varlistentry>
+                <term>--enable-mode-*</term>
+		<listitem><para>
+                  The node layout scheme.
+                  (see Components:<filename>mode*.c</filename>).
+		  <variablelist>
+		    <varlistentry>
+		      <term>--enable-mode-mono</term>
+		      <listitem><para>
+                        The default.
+                      </para></listitem>
+                    </varlistentry>
+                    <varlistentry>
+		      <term>--enable-mode-pairs</term>
+		      <listitem><para>
+                        The default.
+                      </para></listitem>
+                    </varlistentry>
+                  </variablelist>
+                </para></listitem>
+              </varlistentry>
 	      <varlistentry>
 		<term>--enable-tests</term>
 		<listitem><para>
@@ -666,6 +687,37 @@
 	      implementation.
 	  </para></listitem>
 	</varlistentry>
+        <varlistentry>
+	  <term>mode_*.c</term>
+	  <listitem><para>
+            C-MPI mode selection made at configure time.
+            <variablelist>
+              <varlistentry>
+                <term>mono</term>
+                <listitem><para>
+                  Given <literal>mpiexec -n 6 cmpi-db -n 4</literal>,
+                  creates 4 DHT nodes (ranks 0-3)
+                  and 2 clients (ranks 4-5).
+                  The clients will use all nodes as contacts.
+                  Ideal for the SMP case.
+                  </para></listitem>
+              </varlistentry>
+              <varlistentry>
+                <term>pairs</term>
+                <listitem><para>
+                  Given <literal>mpiexec -n 6 cmpi-db -n 3</literal>,
+                  creates 3 DHT nodes (ranks 0-2)
+                  and 3 clients (ranks 3-5).
+                  The clients connect to a single contact
+                  (0:3, 1:4, 2:5).
+                  Ideal for the cluster case: each physical node will
+                  have one node process and one client process,
+                  the client will only contact the local node.
+                  </para></listitem>
+              </varlistentry>
+            </variablelist>
+          </para></listitem>
+	</varlistentry>
 	<varlistentry>
 	  <term>node.c</term>
 	  <listitem><para>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.