Skip to content

Commit 42b9422

Browse files
committed
doc: Add notes about libopen-pal_core
Signed-off-by: Joshua Hursey <[email protected]>
1 parent 0dead9b commit 42b9422

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/developers/source-code.rst

+10
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,16 @@ Each of the three main source directories (``oshmem``, ``ompi``, and
209209
either static or shared libraries. Executables are also produced in
210210
subdirectories of some of the trees.
211211
212+
The ``libopen-pal`` top-level library is built internally in two parts:
213+
214+
* ``libopen-pal_core`` Internal "core" portion of OPAL containing the essential source and MCA needed for tools like mpicc/mpirun to link against. The "core" library is not installed.
215+
216+
* Includes the following MCA frameworks: ``backtrace``, ``dl``, ``if``, ``installdirs``, ``threads``, ``timer``
217+
* Includes all of the source under ``opal/class`` and most of ``opal/util``
218+
* Includes the files suffixed with ``_core`` in ``opal/runtime``
219+
220+
* ``libopen-pal`` Includes "core" plus all of the other OPAL project sources. This is installed.
221+
212222
Each of the sub-project source directories have similar (but not
213223
identical) directory structures under them:
214224

0 commit comments

Comments
 (0)