Changes between Version 4 and Version 5 of doc/app/palmbuild

Timestamp:

Nov 20, 2018 1:48:44 PM (6 years ago)

Author:

kanani

Comment:

--

doc/app/palmbuild

@@ -1 +1 @@
 = The PALM build script =
 
-The script to compile PALM and its [utility (pre-/postprocessing) programs] is called {{{palmbuild}}}. It resides under {{{trunk/SCRIPTS}}} and is invoked by the [wiki:doc/install/automatic automatic installer] as part of the installation process. It can also be executed manually, e.g. in case of a [#svnupdate PALM code update] from the svn repository, or code modifications by the user. Each modifications of the source code requires new compilation.\\\\
+The script to compile PALM and its [utility (pre-/postprocessing) programs] is called {{{palmbuild}}}. It resides under {{{trunk/SCRIPTS}}} and is invoked by the [wiki:doc/install/automatic automatic installer] as part of the installation process. It can also be executed manually, e.g. in case of a [#svnupdate PALM code update] from the svn repository, or code modifications by the user. Each modification of the source code requires new compilation.\\\\
 
 {{{palmbuild}}}\\\\
@@ -15 +15 @@
    palmbuild -c default
 }}}
-Since you can have different configuration files (for different compilers, compiler options, or hosts), you need to specify the configuration file to be used by the option {{{-c}}}. The suffix {{{default}}} in this example is the <configuration identifier>, which can be an arbitrary ASCII-character string.\\
+Since you can have different configuration files (for different compilers, compiler options, or hosts), you need to specify the configuration file to-be-used by the option {{{-c}}}. The suffix {{{default}}} in this example is the <configuration identifier>, which can be an arbitrary ASCII-character string.\\
 
 After entering the command, informative messages will appear in the terminal:
@@ -41 +41 @@
 #------------------------------------------------------------------------# 
 
- >>> continue (y(es)/c(ontinue)/a(bort)) ?  
-}}} 
-If {{{y}}} is entered, compilation will be started and compiler messages will appear. After successful completion, you will find the binaries in the directory given in the configuration file by {{{base_directory}}} under the folder name {{{MAKE_DEPOSITORY_abcde}}}.
+ >>> continue (y(es)/a(bort)) ?  
+}}}
 
-In case of a configuration file for PALM runs on a remote host, sources are copied via {{{scp}}} to the remote host and the compiler is called via {{{ssh}}} on the remote host too. Folder {{{MAKE_DEPOSITORY_abcde}}} is created under {{{base_directory}}} on the remote host.
+After confirmation (y(es)), compilation starts and compiler messages will appear. After successful completion, the binaries reside in the directory {{{MAKE_DEPOSITORY_default}}} under the path given by the variable [%base_directory] in the configuration file. When invoking {{{palmbuild}}} locally for compilation of PALM on a [link-to remote computer], sources are copied via {{{scp}}} to the remote host, and the compiler is called via {{{ssh}}} on the remote host as well. Here, the {{{MAKE_DEPOSITORY_default}}} also lands [%base_directory].
 
-[=#svnupdate In case you have updated the PALM code, you need to call {{{palmbuild}}} again:]
+[=#svnupdate In] case you have updated the PALM code, you need to call {{{palmbuild}}} again:
 {{{
    cd ~/palm/current_version
    svn update trunk
-   palmbuild -c abcde
+   palmbuild -c default
 }}}
 
@@ -57 +56 @@
 {{{
    touch trunk/SOURCE/*.f90
-   palmbuild -c abcde
+   palmbuild -c default
 }}}
 because otherwise the make mechanism would see no changes in the source code and would not compile at all (message {{{make: Nothing to be done}}}). Alternatively, you may delete the MAKE_DEPOSITORY folder:
 {{{
-   rm -rf MAKE_DEPOSITORY_abcde
-   palmbuild -c abcde
+   rm -rf MAKE_DEPOSITORY_default
+   palmbuild -c default
 }}}
-
-If you have more than one configuration file, you need to call {{{palmbuild}}} separately for each configuration.
+**However**, best practice would be to create [link-to individual .palm.config files] for the different configurations, because this prevents from having to re-compile over and over again whenever modifying and working with just one single .palm.config file. Of course, {{{palmbuild}}} has to be executed for each configuration.