STYLE: adjust wording, file-layout

- comments in bashrc, cshrc.
- about controlDict names for allowSystemOperations

etc/bashrc

@@ -54,7 +54,7 @@ FOAM_INST_DIR="$HOME/$WM_PROJECT"
 #
 # END OF (NORMAL) USER EDITABLE PART
 ################################################################################
-: # Extra safety - if the user commented out all fallback values
+: # Safety statement (if the user removed all fallback values)
 unset rc
 
 # Configuration environment variables.
@@ -94,7 +94,7 @@ export WM_MPLIB=SYSTEMOPENMPI
 
 
 #------------------------------------------------------------------------------
-# (legacy / advanced)
+# (advanced / legacy)
 #
 # [FOAM_SIGFPE] - Trap floating-point exceptions.
 #               - overrides the 'trapFpe' controlDict entry
@@ -110,9 +110,17 @@ export WM_MPLIB=SYSTEMOPENMPI
 # = POSIX
 #export WM_OSTYPE=POSIX
 
+# [FOAM_JOB_DIR] - location of jobControl
+#                - unset: equivalent to ~/.OpenFOAM/jobControl
+# export FOAM_JOB_DIR="$HOME/.OpenFOAM/jobControl"
+
+# [FOAM_CODE_TEMPLATES] - dynamicCode templates
+# - unset: uses 'foamEtcFile -list codeTemplates/dynamicCode'
+##export FOAM_CODE_TEMPLATES="$WM_PROJECT_DIR/etc/codeTemplates/dynamicCode"
+
 ################################################################################
 
-# Old directories to be cleaned from PATH, LD_LIBRARY_PATH
+# Capture values of old directories to be cleaned from PATH, LD_LIBRARY_PATH
 foamOldDirs="$WM_PROJECT_DIR $WM_THIRD_PARTY_DIR \
     $HOME/$WM_PROJECT/$USER $FOAM_USER_APPBIN $FOAM_USER_LIBBIN \
     $WM_PROJECT_SITE $FOAM_SITE_APPBIN $FOAM_SITE_LIBBIN"
@@ -122,6 +130,9 @@ export WM_PROJECT_INST_DIR=$FOAM_INST_DIR
 export WM_PROJECT_DIR=$WM_PROJECT_INST_DIR/$WM_PROJECT-$WM_PROJECT_VERSION
 export WM_THIRD_PARTY_DIR=$WM_PROJECT_INST_DIR/ThirdParty-$WM_PROJECT_VERSION
 
+# [WM_PROJECT_USER_DIR] - Location of user files
+export WM_PROJECT_USER_DIR=$HOME/$WM_PROJECT/$USER-$WM_PROJECT_VERSION
+
 # [WM_PROJECT_SITE] - Location of site-specific (group) files
 # default (unset) implies WM_PROJECT_INST_DIR/site
 if [ -d "$WM_PROJECT_SITE" ]
@@ -131,9 +142,6 @@ else
     unset WM_PROJECT_SITE
 fi
 
-# [WM_PROJECT_USER_DIR] - Location of user files
-export WM_PROJECT_USER_DIR=$HOME/$WM_PROJECT/$USER-$WM_PROJECT_VERSION
-
 # Load shell functions
 unset WM_SHELL_FUNCTIONS
 . $WM_PROJECT_DIR/etc/config.sh/functions

etc/config.csh/settings

@@ -138,9 +138,6 @@ endsw
 
 #------------------------------------------------------------------------------
 
-# [FOAM_JOB_DIR] - unset is equivalent to ~/.OpenFOAM/jobControl
-## setenv FOAM_JOB_DIR "$HOME/.OpenFOAM/jobControl"
-
 # wmake configuration
 setenv WM_DIR $WM_PROJECT_DIR/wmake
 setenv WM_LABEL_OPTION Int$WM_LABEL_SIZE
@@ -168,19 +165,6 @@ setenv FOAM_SITE_LIBBIN $siteDir/$WM_PROJECT_VERSION/platforms/$WM_OPTIONS/lib
 setenv FOAM_USER_APPBIN $WM_PROJECT_USER_DIR/platforms/$WM_OPTIONS/bin
 setenv FOAM_USER_LIBBIN $WM_PROJECT_USER_DIR/platforms/$WM_OPTIONS/lib
 
-# [FOAM_CODE_TEMPLATES] - dynamicCode templates
-# * fallback == "foamEtcFile -list codeTemplates/dynamicCode"
-# setenv FOAM_CODE_TEMPLATES $WM_PROJECT_DIR/etc/codeTemplates/dynamicCode
-
-# Convenience
-setenv FOAM_ETC $WM_PROJECT_DIR/etc
-setenv FOAM_APP $WM_PROJECT_DIR/applications
-setenv FOAM_SRC $WM_PROJECT_DIR/src
-setenv FOAM_TUTORIALS $WM_PROJECT_DIR/tutorials
-setenv FOAM_UTILITIES $WM_PROJECT_DIR/applications/utilities
-setenv FOAM_SOLVERS $WM_PROJECT_DIR/applications/solvers
-setenv FOAM_RUN $WM_PROJECT_USER_DIR/run
-
 # Add wmake to the path - not required for runtime-only environment
 if ( -d "${WM_DIR}" ) setenv PATH ${WM_DIR}:${PATH}
 # Add OpenFOAM scripts to the path
@@ -204,6 +188,19 @@ _foamAddLib  ${FOAM_USER_LIBBIN}:${FOAM_SITE_LIBBIN}:${FOAM_LIBBIN}
 
 #------------------------------------------------------------------------------
 
+# Convenience
+# ~~~~~~~~~~~
+
+setenv FOAM_ETC "$WM_PROJECT_DIR/etc"
+setenv FOAM_APP "$WM_PROJECT_DIR/applications"
+setenv FOAM_SRC "$WM_PROJECT_DIR/src"
+setenv FOAM_TUTORIALS "$WM_PROJECT_DIR/tutorials"
+setenv FOAM_UTILITIES "$WM_PROJECT_DIR/applications/utilities"
+setenv FOAM_SOLVERS "$WM_PROJECT_DIR/applications/solvers"
+setenv FOAM_RUN "$WM_PROJECT_USER_DIR/run"
+
+#------------------------------------------------------------------------------
+
 # Compiler settings
 # ~~~~~~~~~~~~~~~~~
 

etc/config.sh/settings

@@ -131,9 +131,6 @@ esac
 
 #------------------------------------------------------------------------------
 
-# [FOAM_JOB_DIR] - unset is equivalent to ~/.OpenFOAM/jobControl
-## export FOAM_JOB_DIR="$HOME/.OpenFOAM/jobControl"
-
 # wmake configuration
 export WM_DIR=$WM_PROJECT_DIR/wmake
 export WM_LABEL_OPTION=Int$WM_LABEL_SIZE
@@ -162,19 +159,6 @@ export FOAM_SITE_LIBBIN=$siteDir/$WM_PROJECT_VERSION/platforms/$WM_OPTIONS/lib
 export FOAM_USER_APPBIN=$WM_PROJECT_USER_DIR/platforms/$WM_OPTIONS/bin
 export FOAM_USER_LIBBIN=$WM_PROJECT_USER_DIR/platforms/$WM_OPTIONS/lib
 
-# [FOAM_CODE_TEMPLATES] - dynamicCode templates
-# * fallback == "foamEtcFile -list codeTemplates/dynamicCode"
-# export FOAM_CODE_TEMPLATES=$WM_PROJECT_DIR/etc/codeTemplates/dynamicCode
-
-# Convenience
-export FOAM_ETC=$WM_PROJECT_DIR/etc
-export FOAM_APP=$WM_PROJECT_DIR/applications
-export FOAM_SRC=$WM_PROJECT_DIR/src
-export FOAM_TUTORIALS=$WM_PROJECT_DIR/tutorials
-export FOAM_UTILITIES=$WM_PROJECT_DIR/applications/utilities
-export FOAM_SOLVERS=$WM_PROJECT_DIR/applications/solvers
-export FOAM_RUN=$WM_PROJECT_USER_DIR/run
-
 # Add wmake to the path - not required for runtime-only environment
 [ -d "$WM_DIR" ] && PATH=$WM_DIR:$PATH
 # Add OpenFOAM scripts to the path
@@ -201,6 +185,19 @@ _foamAddLib  $FOAM_USER_LIBBIN:$FOAM_SITE_LIBBIN:$FOAM_LIBBIN
 
 #------------------------------------------------------------------------------
 
+# Convenience
+# ~~~~~~~~~~~
+
+export FOAM_ETC="$WM_PROJECT_DIR/etc"
+export FOAM_APP="$WM_PROJECT_DIR/applications"
+export FOAM_SRC="$WM_PROJECT_DIR/src"
+export FOAM_TUTORIALS="$WM_PROJECT_DIR/tutorials"
+export FOAM_UTILITIES="$WM_PROJECT_DIR/applications/utilities"
+export FOAM_SOLVERS="$WM_PROJECT_DIR/applications/solvers"
+export FOAM_RUN="$WM_PROJECT_USER_DIR/run"
+
+#------------------------------------------------------------------------------
+
 # Compiler settings
 # ~~~~~~~~~~~~~~~~~
 

etc/cshrc

@@ -92,7 +92,7 @@ setenv WM_MPLIB SYSTEMOPENMPI
 
 
 #------------------------------------------------------------------------------
-# (legacy / advanced)
+# (advanced / legacy)
 #
 # [FOAM_SIGFPE] - Trap floating-point exceptions.
 #               - overrides the 'trapFpe' controlDict entry
@@ -108,6 +108,14 @@ setenv WM_MPLIB SYSTEMOPENMPI
 # = POSIX
 #setenv WM_OSTYPE POSIX
 
+# [FOAM_JOB_DIR] - location of jobControl
+#                - unset: equivalent to ~/.OpenFOAM/jobControl
+#setenv FOAM_JOB_DIR "$HOME/.OpenFOAM/jobControl"
+
+# [FOAM_CODE_TEMPLATES] - dynamicCode templates
+# - unset: uses 'foamEtcFile -list codeTemplates/dynamicCode'
+##setenv FOAM_CODE_TEMPLATES "$WM_PROJECT_DIR/etc/codeTemplates/dynamicCode"
+
 ################################################################################
 
 # Old directories to be cleaned from PATH, LD_LIBRARY_PATH
@@ -133,6 +141,9 @@ setenv WM_PROJECT_INST_DIR $FOAM_INST_DIR
 setenv WM_PROJECT_DIR      $WM_PROJECT_INST_DIR/$WM_PROJECT-$WM_PROJECT_VERSION
 setenv WM_THIRD_PARTY_DIR  $WM_PROJECT_INST_DIR/ThirdParty-$WM_PROJECT_VERSION
 
+# [WM_PROJECT_USER_DIR] - Location of user files
+setenv WM_PROJECT_USER_DIR "$HOME/$WM_PROJECT/$LOGNAME-$WM_PROJECT_VERSION"
+
 # [WM_PROJECT_SITE] - Location of site-specific (group) files
 # default (unset) implies WM_PROJECT_INST_DIR/site
 if ( $?WM_PROJECT_SITE ) then
@@ -142,9 +153,6 @@ else
     unsetenv WM_PROJECT_SITE
 endif
 
-# [WM_PROJECT_USER_DIR] - Location of user files
-setenv WM_PROJECT_USER_DIR $HOME/$WM_PROJECT/$LOGNAME-$WM_PROJECT_VERSION
-
 # Load shell "functions" (actually aliases)
 source $WM_PROJECT_DIR/etc/config.csh/functions
 

src/OpenFOAM/db/dynamicLibrary/dynamicCode/dynamicCode.C

@@ -73,18 +73,16 @@ void Foam::dynamicCode::checkSecurity
     if (!allowSystemOperations)
     {
         FatalIOErrorInFunction(dict)
-            << "Loading a shared library using case-supplied code is not"
+            << "Loading shared libraries using case-supplied code may have"
-            << " enabled by default" << nl
+            << " been disabled" << nl
-            << "because of security issues. If you trust the code you can"
+            << "by default for security reasons." << nl
-            << " enable this" << nl
+            << "If you trust the code, you may enable this by adding"
-            << "facility be adding to the InfoSwitches setting in the system"
+            << nl << nl
-            << " controlDict:" << nl << nl
             << "    allowSystemOperations 1" << nl << nl
-            << "The system controlDict is either" << nl << nl
+            << "to the InfoSwitches setting in the system controlDict." << nl
-            << "    ~/.OpenFOAM/$WM_PROJECT_VERSION/controlDict" << nl << nl
+            << "The system controlDict is any of" << nl << nl
-            << "or" << nl << nl
+            << "    ~/.OpenFOAM/controlDict" << nl
-            << "    $WM_PROJECT_DIR/etc/controlDict" << nl
+            << "    $WM_PROJECT_DIR/etc/controlDict" << nl << endl
-            << endl
             << exit(FatalIOError);
     }
 }

src/functionObjects/utilities/systemCall/systemCall.C

@@ -119,17 +119,16 @@ bool Foam::functionObjects::systemCall::read(const dictionary& dict)
     else if (!dynamicCode::allowSystemOperations)
     {
         FatalErrorInFunction
-            << "Executing user-supplied system calls may not be enabled by "
+            << "Executing user-supplied system calls may have been disabled"
-            << "default due to potential " << nl
+            << " by default" << nl
-            << "security issues.  If you trust the case you can enable this "
+            << "for security reasons." << nl
-            << "facility by " << nl
+            << "If you trust the code, you may enable this by adding"
-            << "adding to the InfoSwitches setting in the system controlDict:"
             << nl << nl
             << "    allowSystemOperations 1" << nl << nl
-            << "The system controlDict is either" << nl << nl
+            << "to the InfoSwitches setting in the system controlDict." << nl
-            << "    ~/.OpenFOAM/$WM_PROJECT_VERSION/controlDict" << nl << nl
+            << "The system controlDict is any of" << nl << nl
-            << "or" << nl << nl
+            << "    ~/.OpenFOAM/controlDict" << nl
-            << "    $WM_PROJECT_DIR/etc/controlDict" << nl << nl
+            << "    $WM_PROJECT_DIR/etc/controlDict" << nl << endl
             << exit(FatalError);
     }