From 2162304950cc3c63059336aeb5b15a0a9c4a6a98 Mon Sep 17 00:00:00 2001 From: Gerhard Theurich Date: Wed, 8 Nov 2023 10:45:04 -0800 Subject: [PATCH] User's guide cleanup and minor improvements. --- src/doc/ESMF_builddetail.tex | 2 +- src/doc/ESMF_quickstart.tex | 11 ++++++----- src/doc/ESMF_techoverview.tex | 4 ++-- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/doc/ESMF_builddetail.tex b/src/doc/ESMF_builddetail.tex index 48a97fa934..1814355a9d 100644 --- a/src/doc/ESMF_builddetail.tex +++ b/src/doc/ESMF_builddetail.tex @@ -153,7 +153,7 @@ \subsubsection{Source code configuration} the build system provides a path to the correct files during source code compilation. -\subsection{Porting the ESMF to New Platforms} +\subsection{Porting ESMF to New Platforms} The ESMF build system can be ported to other Unix platforms by adding a new platform specific makefile fragment and two associated configuration files. diff --git a/src/doc/ESMF_quickstart.tex b/src/doc/ESMF_quickstart.tex index a5aec88915..151ae2be3a 100644 --- a/src/doc/ESMF_quickstart.tex +++ b/src/doc/ESMF_quickstart.tex @@ -8,8 +8,7 @@ \section{Quick Start} \ref{sec:TechOver2} and \ref{sec:CLTs}, respectively. With a growing user community requiring access to ESMF, central computing -resources (such as ORNL for the {\it Jaguar} and {\it Kraken} supercomputers) -have recently started providing system wide ESMF installations. The availablity +resources have started providing system wide ESMF installations. The availablity of center-managed ESMF installations dramatically increases the ease of use of ESMF. Practically it means that if you are working on a system (such as {\it Jaguar}) that offers a standard ESMF installation, you do not have to @@ -52,7 +51,9 @@ \subsection{Building ESMF} \item Type {\tt make check } to run self-tests to verify the build was successful. \end{enumerate} -See the following sections for more information on each of these steps. +See the following subsections for more information on each of these steps. Also +consult section \ref{sec:TechOver} for a complete discussion of the the ESMF +build process. \subsubsection{Environment variables} @@ -66,8 +67,8 @@ \subsubsection{Environment variables} The shell environment variables listed below are the ones most frequently used. There are others which address needs on specific -platforms or are needed under more unusual circumstances; -see Section \ref{sec:TechOver} for the full list. +platforms or are needed under more unusual circumstances; +see section \ref{sec:TechOver} for the full list. \begin{description} \item[ESMF\_DIR] diff --git a/src/doc/ESMF_techoverview.tex b/src/doc/ESMF_techoverview.tex index 517071c898..9df0aec738 100644 --- a/src/doc/ESMF_techoverview.tex +++ b/src/doc/ESMF_techoverview.tex @@ -18,7 +18,7 @@ \section{Using Bundled ESMF Command Line Tools} \newpage -\section{Building and Installing the ESMF} +\section{Building and Installing ESMF} \label{sec:TechOver} This section goes into more detail about how to build and install the ESMF @@ -27,7 +27,7 @@ \section{Building and Installing the ESMF} \input{ESMF_install} -\section{Porting the ESMF} +\section{Porting ESMF} \label{sec:TechOverPort} This section goes into more detail about the ESMF build system and how to