Skip to content

Commit b190d91

Browse files
committed
Remove empty lines as we now can rely on css to do line break
1 parent 0468bc5 commit b190d91

File tree

1 file changed

+1
-59
lines changed

1 file changed

+1
-59
lines changed

darshan-runtime/doc/darshan-runtime.rst

Lines changed: 1 addition & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -600,7 +600,7 @@ runtime:
600600

601601
.. list-table::
602602
:header-rows: 1
603-
:widths: 30 30 40
603+
:widths: 30 20 50
604604
:class: tight-table
605605
:align: left
606606

@@ -623,193 +623,135 @@ runtime:
623623
* - DARSHAN_DISABLE_SHARED_REDUCTION=1
624624
- DISABLE_SHARED_REDUCTION
625625
- Disables the step in Darshan aggregation in which files that were
626-
627626
accessed by all ranks are collapsed into a single cumulative file record
628-
629627
at rank 0. This option retains more per-process information at the
630-
631628
expense of creating larger log files.
632629
* - DARSHAN_INTERNAL_TIMING=1
633630
- INTERNAL_TIMING
634631
- Enables internal instrumentation that will print the time required to
635-
636632
startup and shutdown Darshan to stderr at runtime.
637633
* - DARSHAN_MODMEM=<val>
638634
- MODMEM <val>
639635
- Specifies the amount of memory (in MiB) Darshan instrumentation modules
640-
641636
can collectively consume (if not specified, a default 4 MiB quota is
642-
643637
used). Overrides any ``--with-mod-mem`` configure argument.
644638
* - DARSHAN_NAMEMEM=<val>
645639
- NAMEMEM <val>
646640
- Specifies the amount of memory (in MiB) Darshan can consume for storing
647-
648641
record names (if not specified, a default 1 MiB quota is used).
649-
650642
Overrides any ``--with-name-mem`` configure argument.
651643
* - DARSHAN_MEMALIGN=<val>
652644
- MEMALIGN <val>
653645
- Specifies a value for system memory alignment. Overrides any
654-
655646
``--with-mem-align`` configure argument (default is 8 bytes).
656647
* - DARSHAN_JOBID=<string>
657648
- JOBID <string>
658649
- Specifies the name of the environment variable to use for the job
659-
660650
identifier, such as PBS_JOBID. Overrides ``--with-jobid-env`` configure
661-
662651
argument.
663652
* - DARSHAN_LOGHINTS=<string>
664653
- LOGHINTS <string>
665654
- Specifies the MPI-IO hints to use when storing the Darshan output file.
666-
667655
The format is a semicolon-delimited list of key=value pairs, for
668-
669656
example: hint1=value1;hint2=value2. Overrides any ``--with-log-hints``
670-
671657
configure argument.
672658
* - DARSHAN_LOGPATH=<path>
673659
- LOGPATH <path>
674660
- Specifies the path to write Darshan log files to. Note that this
675-
676661
directory needs to be formatted using the darshan-mk-log-dirs script.
677-
678662
Overrides any ``--with-log-path`` configure argument.
679663
* - DARSHAN_MMAP_LOGPATH=<path>
680664
- MMAP_LOGPATH <path>
681665
- If Darshan's mmap log file mechanism is enabled, this variable specifies
682-
683666
what path the mmap log files should be stored in (if not specified, log
684-
685667
files will be stored in ``/tmp``).
686668
* - DARSHAN_LOGFILE=<path>
687669
- N/A
688670
- Specifies the path (directory + Darshan log file name) to write the
689-
690671
output Darshan log to. This overrides the default Darshan behavior of
691-
692672
automatically generating a log file name and adding it to a log file
693-
694673
directory formatted using darshan-mk-log-dirs script.
695674
* - DARSHAN_MOD_DISABLE=<mod_csv>
696675
- MOD_DISABLE <mod_csv>
697676
- Specifies a list of comma-separated Darshan module names to disable at
698-
699677
runtime.
700678
* - DARSHAN_MOD_ENABLE=<mod_csv>
701679
- MOD_ENABLE <mod_csv>
702680
- Specifies a list of comma-separated Darshan module names to enable at
703-
704681
runtime.
705682
* - DARSHAN_APP_EXCLUDE=<regex_csv>
706683
- APP_EXCLUDE <regex_csv>
707684
- Specifies a list of comma-separated regexes that match application names
708-
709685
that should not be instrumented. This is useful if Darshan is
710-
711686
``LD_PRELOAD``, in which case logs may be generated for many unintended
712-
713687
applications.
714688
* - DARSHAN_APP_INCLUDE=<regex_csv>
715689
- APP_INCLUDE <regex_csv>
716690
- Specifies a list of comma-separated regexes that match application names
717-
718691
that should be instrumented. This setting is used to override any
719-
720692
APP_INCLUDE rules.
721693
* - DARSHAN_RANK_EXCLUDE=<rank_csv>
722694
- RANK_EXCLUDE <rank_csv>
723695
- Specifies a list of comma-separated ranks (or rank ranges) that should
724-
725696
not be instrumented. Rank ranges are formatted like "start:end" (if
726-
727697
start or end are not specified, the first or last rank is assumed,
728-
729698
respectively). Note that the Darshan library will still run on all
730-
731699
processes of an application, this setting just controls whether specific
732-
733700
ranks are capturing instrumentation data.
734701
* - DARSHAN_RANK_INCLUDE=<rank_csv>
735702
- RANK_INCLUDE <rank_csv>
736703
- Specifies a list of comma-separated ranks (or rank ranges) that should
737-
738704
be instrumented. This setting is used to override any RANK_INCLUDE
739-
740705
rules.
741706
* - DARSHAN_DXT_SMALL_IO_TRIGGER=<val>
742707
- DXT_SMALL_IO_TRIGGER <val>
743708
- Specifies a floating point percentage (i.e., ".8" would be 80%)
744-
745709
indicating a threshold of small I/O operation accesses (defined as
746-
747710
accesses smaller than 10 KiB), with DXT trace data being discarded for
748-
749711
files that exhibit a percentage of small I/O operations less than this
750-
751712
threshold.
752713
* - DARSHAN_DXT_UNALIGNED_IO_TRIGGER=<val>
753714
- DXT_UNALIGNED_IO_TRIGGER <val>
754715
- Specifies a floating point percentage (i.e., ".8" would be 80%)
755-
756716
indicating a threshold of unaligned I/O operation accesses (defined as
757-
758717
accesses not aligned to the file alignment value determined by Darshan),
759-
760718
with DXT trace data being discarded for files that exhibit a percentage
761-
762719
of unaligned I/O operations less than this threshold.
763720
* - N/A
764721
- MAX_RECORDS <val> <mod_csv>
765722
- Specifies the number of records to pre-allocate for each instrumentation
766-
767723
module given in a comma-separated list. Most modules default to tracing
768-
769724
1024 file records per-process.
770725
* - N/A
771726
- NAME_EXCLUDE <regex_csv> <mod_csv>
772727
- Specifies a list of comma-separated regexes that match record names that
773-
774728
should not be instrumented for instrumentation modules given in a
775-
776729
comma-separated module list.
777730
* - N/A
778731
- NAME_INCLUDE <regex_csv> <mod_csv>
779732
- Specifies a list of comma-separated regexes that match record names that
780-
781733
should be instrumented for instrumentation modules given in a
782-
783734
comma-separated module list. This setting is used to override any
784-
785735
NAME_EXCLUDE rules.
786736
* - DXT_ENABLE_IO_TRACE=1
787737
- N/A
788738
- (DEPRECATED) Setting this environment variable enables the DXT (Darshan
789-
790739
eXtended Tracing) modules at runtime for all files instrumented by
791-
792740
Darshan. Replaced by MODULE_ENABLE setting.
793741
* - DARSHAN_EXCLUDE_DIRS=<path_csv>
794742
- N/A
795743
- (DEPRECATED) Specifies a list of comma-separated paths that Darshan will
796-
797744
not instrument at runtime (in addition to Darshan's default exclusion
798-
799745
list). Replaced by NAME_EXCLUDE setting.
800746
* - DARSHAN_LDMS_ENABLE=
801747
- N/A
802748
- Switch to initialize LDMS. If not set, no runtime I/O data will be
803-
804749
collected. This only needs to be exported (i.e. setting to a
805-
806750
value/string is optional).
807751
* - DARSHAN_LDMS_ENABLE_<mod_name>=
808752
- N/A
809753
- Specifies the module data that will be collected during runtime using
810-
811754
LDMS streams API. These only need to be exported (i.e. setting to a
812-
813755
value/string is optional).
814756

815757
.. note::

0 commit comments

Comments
 (0)