Skip to content

Commit

Permalink
HDF5: add doc for INC_DIRS and LIB_DIRS
Browse files Browse the repository at this point in the history
  • Loading branch information
rhaas80 committed Feb 1, 2021
1 parent 7090973 commit abf8dbf
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions doc/documentation.tex
Expand Up @@ -9,8 +9,8 @@
\begin{document}

\title{\tt ExternalLibraries/HDF5}
\author{Yaakoub Y El-Khamra, Thomas Radke}
\date{$ $Date: 2007/11/12 16:24:16 $ $}
\author{Yaakoub Y El-Khamra, Thomas Radke,Federico Cipolletta}
\date{2020-07-01}

\maketitle

Expand Down Expand Up @@ -57,6 +57,29 @@
a usage message.
\end{abstract}

\section{Using This Thorn}

Refer to the Cactus UserGuide, Sec. B2.2, in order to know how this thorn can be used in a compiled configuration and how to possibly linking another specific version, already installed steparately.

\subsection*{Note on possible ExternalLibraries' location stripping}
\label{stripping}

Each thorn contained in \texttt{Cactus/arrangements/ExternalLibraries} will automatically adopt the library version contained in the \texttt{Cactus/arrangements/<library>/dist} folder. In particular, the tarball in \texttt{Cactus/arrangements/<library>/dist} is only used if either \texttt{THORN\_DIR} is set to \texttt{BUILD} or is left empty and no precompiled copy of the library is found. If another location is specified via the \texttt{THORN\_DIR} variable in the \texttt{<machine>.cfg} file at compilation, then the \texttt{Cactus/lib/sbin/strip-incdirs.sh} script will automatically strip away (for safety reasons) the locations:
\begin{Lentry}
\item [\texttt{/include}]
\item [\texttt{/usr/include}]
\item [\texttt{/usr/local/include}]
\end{Lentry}
from \texttt{THORN\_INC\_DIRS} which default to \texttt{THORN\_DIR/include}. Therefore, if there is any need for using one already installed version of one external library, the aforementioned location should be avoided (e.g. indicating \texttt{/home} as the \texttt{THORN\_DIR} will work with no problems if the required library is installed there) or should be carefully checked, in order to avoid unwanted stripping. The same stripping happens to \texttt{THORN\_LIB\_DIRS} in \texttt{lib/sbin/strip-libdirs.sh} with a larger list of directories:
\begin{Lentry}
\item [\texttt{/lib}]
\item [\texttt{/usr/lib}]
\item [\texttt{/usr/local/lib}]
\item [\texttt{/lib64}]
\item [\texttt{/usr/lib64}]
\item [\texttt{/usr/local/lib64}]
\end{Lentry}

% Do not delete next line
% END CACTUS THORNGUIDE

Expand Down

0 comments on commit abf8dbf

Please sign in to comment.