collectTrace to allow partial trace buffer collection

Change-Id: I06ce6df416f38c4619281180ea8515c90f8f2fab
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/498
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>
Tested-by: Jenkins Server

1 files changed, 15 insertions, 8 deletions

diff --git a/src/include/usr/errl/errlentry.H b/src/include/usr/errl/errlentry.H
index 5046cd1c6..b3e856996 100644
--- a/src/include/usr/errl/errlentry.H
+++ b/src/include/usr/errl/errlentry.H
@@ -329,19 +329,26 @@ public:
 
     /**
      *  @brief Collect component trace
-     *  The given component's trace is collected (if possible)
-     *  and added to the log's data sections.  The amount of data
-     *  added is the smallest of the log's available space (up to
-     *  1024 bytes of trace) or the given input max.
+     *  The trace buffer named is collected and added to the error
+     *  log.  The amount of traces is controlled by the i_max parameter.
+     *  When zero, or left to default, the full trace buffer is copied.
+     *  Otherwise, i_max size must be big enough to hold a trace buffer
+     *  header (40 bytes) plus some trace data. For example, a trace
+     *  entry with n bytes of data is n+28 bytes in size.
      *
-     *  @param[in]  i_Name          Component Name
-     *  @param[in]  i_Max           Upper limit of trace to capture.
+     *  Note that component names given in hbotcompid.H do not necessarily
+     *  map to the names of trace buffers created by that component.
+     *  Trace buffer names are case insensitive.
+     *
+     *  @param[in]  i_name          Trace buffer name
+     *  @param[in]  i_max           Size of trace to capture.
      *
      *  @return A Boolean indication of success.  False likely means
-     *  the component name input is not found.
+     *  the trace buffer name given is not found. However, check the ERRL
+     *  trace buffer for the cause of the failure.
      */
     bool collectTrace(const char i_name[],
-                      const uint32_t i_max = 0);
+                      const uint64_t i_max = 0);