Add description of preloading GID and LID destination caches to acm_notes.txt

Signed-off-by: Hal Rosenstock <hal@mellanox.com>
Signed-off-by: Sean Hefty <sean.hefty@intel.com>

diff --git a/acm_notes.txt b/acm_notes.txt
index 075bc6e1e755e96e2952f549cb08d316222f09c7..fac09201ac1f27a5460335be9d9a73a6766e0382 100644 (file)
--- a/acm_notes.txt
+++ b/acm_notes.txt
@@ -119,11 +119,19 @@ the multicast group that was selected to construct or obtain path record
 data, which is returned to the client.
 
 The current implementation of the IB ACM has several additional restrictions:
-- The ib_acm is limited in its handling of dynamic changes;
-  the ib_acm must be stopped and restarted if a cluster is reconfigured.
-- Cached data does not timed out and is only updated if a new resolution
-  request is received from a different QPN than a cached request.
+- The ibacm is limited in its handling of dynamic changes;
+  the ibacm should be stopped and restarted if a cluster is reconfigured.
 - Support for IPv6 has not been verified.
 - The number of addresses that can be assigned to a single endpoint is
   limited to 4.
 - The number of multicast groups that an endpoint can support is limited to 2.
+
+The ibacm contains several internal caches.  These include  caches  for
+GID  and  LID  destination  addresses.   These caches can be optionally
+preloaded.  ibacm supports the OpenSM dump_pr plugin "full" PathRecord
+format which is used to preload these caches.  The file format is specified
+in the ibacm_opts.cfg file via the route_preload setting which should
+be set to opensm_full_v1 for this file format.  Default format is
+none which does not preload these caches.  See dump_pr.notes.txt in dump_pr
+for more information on the opensm_full_v1 file format and how to configure
+OpenSM to generate this file.

diff --git a/man/ibacm.1 b/man/ibacm.1
index 9df6062be1c8b2577d3027deedaad8e474e847db..ec97b35c1e45471cba0c99fd49759e846ee4921a 100644 (file)
--- a/man/ibacm.1
+++ b/man/ibacm.1
@@ -152,7 +152,7 @@ preloaded. ibacm supports the OpenSM dump_pr plugin "full" PathRecord
 format which is used to preload these caches.
 The file format is specified in the ibacm_opts.cfg file via the
 path_rec_fmt parameter which should be set to full_opensm_v1 for this file
-format.  Default is none which does not preload these caches.
+format.  Default format is none which does not preload these caches.
 See dump_pr.notes.txt in dump_pr for more information on the
 full_opensm_v1 file format and how to configure OpenSM to
 generate this file.