/[MITgcm]/manual/s_getstarted/text/getting_started.tex

Diff of /manual/s_getstarted/text/getting_started.tex

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.41 by jmc,
Fri Jan 22 00:38:16 2010 UTC
+revision 1.42 by jmc,
Fri May 28 02:09:59 2010 UTC
 Line 520 
 To compile the code, first use the progr
  in the \texttt{tools} directory) to generate a Makefile.
  \texttt{genmake2} is a shell script written to work with all
  ``sh''--compatible shells including bash v1, bash v2, and Bourne.
- Internally, \texttt{genmake2} determines the locations of needed
+ %Internally, \texttt{genmake2} determines the locations of needed
- files, the compiler, compiler options, libraries, and Unix tools.  It
+ %files, the compiler, compiler options, libraries, and Unix tools.  It
- relies upon a number of ``optfiles'' located in the
+ %relies upon a number of ``optfiles'' located in the
- \texttt{tools/build\_options} directory.
+ %\texttt{tools/build\_options} directory.
+ \texttt{genmake2} parses information from the following sources:
+ \begin{description}
+ \item[-] a {\em gemake\_local} file if one is found in the current
+   directory
+ \item[-] command-line options
+ \item[-] an "options file" as specified by the command-line option
+   \texttt{--optfile=/PATH/FILENAME}
+ \item[-] a {\em packages.conf} file (if one is found) with the
+   specific list of packages to compile. The search path for
+   file {\em packages.conf} is, first, the current directory and
+   then each of the "MODS" directories in the given order (see below).
+ \end{description}
+ \subsubsection{Optfiles in \texttt{tools/build\_options} directory:}
  The purpose of the optfiles is to provide all the compilation options
  for particular ``platforms'' (where ``platform'' roughly means the
-Line 596 
 for inclusion.  Please send the file to
+Line 610 
 for inclusion.  Please send the file to
  \begin{rawhtml} </A> \end{rawhtml}
  mailing list.
+ \subsubsection{Command-line options:}
  In addition to the optfiles, \texttt{genmake2} supports a number of
  helpful command-line options.  A complete list of these options can be
  obtained from:
-Line 618 
 The most important command-line options
+Line 634 
 The most important command-line options
    the user's path.  When these three items have been identified,
    genmake2 will try to find an optfile that has a matching name.
- \item[\texttt{--pdefault='PKG1 PKG2 PKG3 ...'}] specifies the default
+ \item[\texttt{--mods='DIR1 DIR2 DIR3 ...'}] specifies a list of
-   set of packages to be used.  The normal order of precedence for
+   directories containing ``modifications''.  These directories contain
-   packages is as follows:
+   files with names that may (or may not) exist in the main MITgcm
-   \begin{enumerate}
+   source tree but will be overridden by any identically-named sources
-   \item If available, the command line (\texttt{--pdefault}) settings
+   within the ``MODS'' directories.
-     over-rule any others.
+   The order of precedence for this "name-hiding" is as follows:
-   \item Next, \texttt{genmake2} will look for a file named
+   \begin{itemize}
-     ``\texttt{packages.conf}'' in the local directory or in any of the
+   \item ``MODS'' directories (in the order given)
-     directories specified with the \texttt{--mods} option.
+   \item Packages either explicitly specified or provided by default
+     (in the order given)
-   \item Finally, if neither of the above are available,
+   \item Packages included due to package dependencies (in the order
-     \texttt{genmake2} will use the \texttt{/pkg/pkg\_default} file.
+     that that package dependencies are parsed)
-   \end{enumerate}
+   \item The "standard dirs" (which may have been specified by the
+     ``-standarddirs'' option)
+   \end{itemize}
+ \item[\texttt{--pgroups=/PATH/FILENAME}] specifies the file
+   where package groups are defined. If not set, the package-groups
+   definition will be read from {\em pkg/pkg\_groups}.
+   It also contains the default list of packages (defined
+   as the group ``{\it default\_pkg\_list}'' which is used
+   when no specific package list ({\em packages.conf})
+   is found in current directory or in any "MODS" directory.
  \item[\texttt{--pdepend=/PATH/FILENAME}] specifies the dependency file
    used for packages.
-Line 657 
 The most important command-line options
+Line 683 
 The most important command-line options
    "STAF" compiler.  As with any compilers, it is helpful to have their
    directories listed in your {\tt \$PATH} environment variable.
- \item[\texttt{--mods='DIR1 DIR2 DIR3 ...'}] specifies a list of
-   directories containing ``modifications''.  These directories contain
-   files with names that may (or may not) exist in the main MITgcm
-   source tree but will be overridden by any identically-named sources
-   within the ``MODS'' directories.
-   The order of precedence for this "name-hiding" is as follows:
-   \begin{itemize}
-   \item ``MODS'' directories (in the order given)
-   \item Packages either explicitly specified or provided by default
-     (in the order given)
-   \item Packages included due to package dependencies (in the order
-     that that package dependencies are parsed)
-   \item The "standard dirs" (which may have been specified by the
-     ``-standarddirs'' option)
-   \end{itemize}
  \item[\texttt{--mpi}] This option enables certain MPI features (using
    CPP \texttt{\#define}s) within the code and is necessary for MPI
    builds (see Section \ref{sect:mpi-build}).

 Legend:



Removed from v.1.41
 


changed lines


 
Added in v.1.42
 Legend:



Removed from v.1.41
 


changed lines


 
Added in v.1.42
-Removed from v.1.41
+Added in v.1.42

	ViewVC Help
Powered by ViewVC 1.1.22