[Darshan-commits] [Git][darshan/darshan][carns/dev-dyn-link-updates] add mpich recipe back in, fix misc spelling

[Philip Carns]

Philip Carns pushed to branch carns/dev-dyn-link-updates at darshan / darshan


Commits:
fd47cee4 by Phil Carns at 2020-03-25T17:13:29-04:00
add mpich recipe back in, fix misc spelling

- - - - -


1 changed file:

- darshan-runtime/doc/darshan-runtime.txt


Changes:

=====================================
darshan-runtime/doc/darshan-runtime.txt
=====================================
@@ -17,7 +17,7 @@ applications (specifically, those that call `MPI_Init()` and `MPI_Finalize()`),
 but, as of version 3.2.0, Darshan also supports instrumentation of non-MPI
 applications. Regardless of whether MPI is used, Darshan provides detailed
 statistics about POSIX level file accesses made by the application.
-In the case of MPI applications, Darshan additionally captures detals on MPI-IO
+In the case of MPI applications, Darshan additionally captures details on MPI-IO
 level access, as well as limited information about HDF5 and PnetCDF access.
 Note that instrumentation of non-MPI applications is currently only supported
 in Darshan's shared library, which applications must `LD_PRELOAD`.
@@ -48,7 +48,7 @@ http://www.mcs.anl.gov/darshan[Darshan web site].
 
 == Requirements
 
-* C compiler (preferrably GCC-compatible)
+* C compiler (preferably GCC-compatible)
 * zlib development headers and library
 
 == Compilation
@@ -205,7 +205,7 @@ darshan-config --dyn-ld-flags
 
 # linker options to use for static linking
 #   The first set of arguments should go early in the link command line
-#   (before MPI, while the second set should go at the end fo the link command
+#   (before MPI, while the second set should go at the end of the link command
 #   line
 darshan-config --pre-ld-flags
 darshan-config --post-ld-flags
@@ -244,7 +244,7 @@ you need examples for static linking.
 === Option 2: Instrumenting MPI applications at run time
 
 This method is applicable to pre-compiled dynamically linked executables
-as well as interpretted languages such as Python.  You do not need to
+as well as interpreted languages such as Python.  You do not need to
 change your compile options in any way.  This method works by injecting
 instrumentation at run time.  It will not work for statically linked
 executables.
@@ -340,7 +340,7 @@ export DXT_ENABLE_IO_TRACE=1
 ----
 
 To enable tracing for particular files, DXT additionally offers a trace
-triggering mechansim, with users specifying triggers used to decide whether or
+triggering mechanism, with users specifying triggers used to decide whether or
 not to trace a particular file at runtime. Files that do not match any trace
 trigger will not store trace data in the Darshan log. Currently, DXT supports
 the following types of trace triggers:
@@ -351,7 +351,7 @@ the following types of trace triggers:
 
 Users simply need to specify one or more of these triggers in a text file that is passed
 to DXT at runtime -- when multiple triggers are specified, DXT will keep any file traces
-that match at least one trigger (i.e., the trace decision is a logical OR accross given triggers).
+that match at least one trigger (i.e., the trace decision is a logical OR across given triggers).
 An example configuration file is given below, illustrating the syntax to use for currently
 supported triggers:
 
@@ -475,6 +475,28 @@ module use /soft/darshan-2.2.3/share/craype-<VERSION>/modulefiles
 From this point, Darshan instrumenation can be enabled for all future
 application compilations by running "module load darshan".
 
+=== Linux clusters using MPICH
+
+Most Intel MPI installations produce dynamic executables by default.  To
+configure Darshan in this environment you can use the following example:
+
+----
+./configure --with-log-path=/darshan-logs --with-jobid-env=PBS_JOBID CC=mpicc
+----
+
+.Rationale
+[NOTE]
+====
+There is nothing unusual in this configuration except that you should use
+the underlying GNU compilers rather than the Intel ICC compilers to compile
+Darshan itself.
+====
+
+We recommend using the darshan-gen-* script described earlier in this
+document to create variants of the standard mpicc/mpicxx/mpif77/mpif90
+scipts that are Darshan enabled.  These scripts will work correctly for both
+dynamic and statically linked executables.
+
 === Linux clusters using Intel MPI
 
 Most Intel MPI installations produce dynamic executables by default.  To



View it on GitLab: https://xgitlab.cels.anl.gov/darshan/darshan/commit/fd47cee438040d0ced86bc11ea67e0b1780592b1

-- 
View it on GitLab: https://xgitlab.cels.anl.gov/darshan/darshan/commit/fd47cee438040d0ced86bc11ea67e0b1780592b1
You're receiving this email because of your account on xgitlab.cels.anl.gov.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/darshan-commits/attachments/20200325/5b36fa80/attachment-0001.html>