From cd265693f59f081cf180948706067e8f1a711ab8 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Sun, 24 Jan 2016 14:37:39 +0000
Subject: [PATCH] wmake: Update comments
---
wmake/makefiles/files | 2 +-
wmake/scripts/makeFiles | 4 ++--
wmake/wmakeFilesAndOptions | 4 ++--
wmake/wmakeLnInclude | 4 ++--
wmake/wmakeLnIncludeAll | 4 ++--
wmake/wmakeScheduler | 6 +++---
wmake/wmakeSchedulerUptime | 23 +++++++++++------------
7 files changed, 23 insertions(+), 24 deletions(-)
diff --git a/wmake/makefiles/files b/wmake/makefiles/files
index 22c6a05f5ea..521d9341ad3 100644
--- a/wmake/makefiles/files
+++ b/wmake/makefiles/files
@@ -34,7 +34,7 @@ include $(GENERAL_RULES)/general
#------------------------------------------------------------------------------
-# declare names of make system control files derived from file 'files'
+# Declare names of make system control files derived from file 'files'
#------------------------------------------------------------------------------
OBJECTS_DIR = $(MAKE_DIR)/$(WM_OPTIONS)
diff --git a/wmake/scripts/makeFiles b/wmake/scripts/makeFiles
index c5b99db9cf2..62f21baf937 100755
--- a/wmake/scripts/makeFiles
+++ b/wmake/scripts/makeFiles
@@ -3,7 +3,7 @@
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
-# \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
+# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
# \\/ M anipulation |
#------------------------------------------------------------------------------
# License
@@ -47,7 +47,7 @@ for dir in `find . -type d -print`
do
case "$dir" in
. | ./Make | ./lnInclude )
- # skip special directories
+ # Skip special directories
;;
*)
baseDir=`echo $dir | sed 's%^\./%%'`
diff --git a/wmake/wmakeFilesAndOptions b/wmake/wmakeFilesAndOptions
index 560f2c1ad68..488c211ab4e 100755
--- a/wmake/wmakeFilesAndOptions
+++ b/wmake/wmakeFilesAndOptions
@@ -3,7 +3,7 @@
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
-# \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
# \\/ M anipulation |
#-------------------------------------------------------------------------------
# License
@@ -56,7 +56,7 @@ USAGE
while [ "$#" -gt 0 ]
do
case "$1" in
- -h | -help) # provide immediate help
+ -h | -help) # Provide immediate help
usage
;;
-*)
diff --git a/wmake/wmakeLnInclude b/wmake/wmakeLnInclude
index 05d2b9f5169..28f4276b9dd 100755
--- a/wmake/wmakeLnInclude
+++ b/wmake/wmakeLnInclude
@@ -3,7 +3,7 @@
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
-# \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
# \\/ M anipulation |
#-------------------------------------------------------------------------------
# License
@@ -78,7 +78,7 @@ unset update silentOpt
while [ "$#" -gt 0 ]
do
case "$1" in
- -h | -help) # provide immediate help
+ -h | -help) # Provide immediate help
usage
;;
-u | -update)
diff --git a/wmake/wmakeLnIncludeAll b/wmake/wmakeLnIncludeAll
index 2aa833c8d62..7c4c3fa8ac8 100755
--- a/wmake/wmakeLnIncludeAll
+++ b/wmake/wmakeLnIncludeAll
@@ -3,7 +3,7 @@
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
-# \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
# \\/ M anipulation |
#-------------------------------------------------------------------------------
# License
@@ -58,7 +58,7 @@ findName=lnInclude
while [ "$#" -gt 0 ]
do
case "$1" in
- -h | -help) # provide immediate help
+ -h | -help) # Provide immediate help
usage
;;
-*)
diff --git a/wmake/wmakeScheduler b/wmake/wmakeScheduler
index 11a22009c40..a927af7a378 100755
--- a/wmake/wmakeScheduler
+++ b/wmake/wmakeScheduler
@@ -3,7 +3,7 @@
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
-# \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
# \\/ M anipulation |
#-------------------------------------------------------------------------------
# License
@@ -108,8 +108,8 @@ fi
# Construct test string for remote execution.
# Source WM_PROJECT settings if WM_PROJECT environment not set.
-# attempt to preserve the installation directory 'FOAM_INST_DIR'
-# use FOAM_SETTINGS to pass command-line settings
+# Attempt to preserve the installation directory 'FOAM_INST_DIR'
+# Use FOAM_SETTINGS to pass command-line settings
case $sourceFoam in
*/bashrc)
if [ "$FOAM_INST_DIR" ]
diff --git a/wmake/wmakeSchedulerUptime b/wmake/wmakeSchedulerUptime
index 1ef11f97b3f..6239f9e65c4 100755
--- a/wmake/wmakeSchedulerUptime
+++ b/wmake/wmakeSchedulerUptime
@@ -3,7 +3,7 @@
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
-# \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
# \\/ M anipulation |
#-------------------------------------------------------------------------------
# License
@@ -64,7 +64,7 @@ then
for slotGroup in $WM_HOSTS
do
n=${slotGroup##*:}
- [ "$n" = "${slotGroup%%:*}" ] && n=1 # missing ':'
+ [ "$n" = "${slotGroup%%:*}" ] && n=1 # Missing ':'
echo "+ ${n:-1}"
done
)
@@ -76,7 +76,7 @@ fi
# !! Assumes remote computer running same shell and startup files
# in same location
-sourceFoam=false # fallback command
+sourceFoam=false # Fallback command
case $SHELL in
*/csh | */tcsh ) # [t]csh vs bash|ksh|sh
shellRc=cshrc
@@ -107,8 +107,8 @@ fi
# Construct test string for remote execution.
# Source WM_PROJECT settings if WM_PROJECT environment not set.
-# attempt to preserve the installation directory 'FOAM_INST_DIR'
-# use FOAM_SETTINGS to pass command-line settings
+# Attempt to preserve the installation directory 'FOAM_INST_DIR'
+# Use FOAM_SETTINGS to pass command-line settings
case $sourceFoam in
*/bashrc)
if [ "$FOAM_INST_DIR" ]
@@ -125,9 +125,9 @@ case $sourceFoam in
;;
esac
-# quote double-quotes for remote command line
+# Quote double-quotes for remote command line
rcmd=$(echo $* | sed -e s/\"/\'\"\'/g)
-## the same, without forking (not ksh, maybe not /bin/sh either)
+# The same, without forking (not ksh, maybe not /bin/sh either)
# rcmd=$(while [ "$#" -gt 0 ]; do echo "${1//\"/'\"'}"; shift; done)
@@ -147,7 +147,7 @@ set -o pipefail
#
-# colour output by argument 1
+# Colour output by argument 1
#
colourPipe()
{
@@ -168,7 +168,7 @@ colourPipe()
-# parse options
+# Parse options
nprocs=1
while [ "$#" -gt 0 ]
do
@@ -194,10 +194,10 @@ while :
do
for slotGroup in $WM_HOSTS
do
- # split 'host:N', but catch 'host:' and 'host' too
+ # Split 'host:N', but catch 'host:' and 'host' too
host=${slotGroup%%:*}
n=${slotGroup##*:}
- [ "$n" = "$host" ] && n=1 # missing ':'
+ [ "$n" = "$host" ] && n=1 # Missing ':'
: ${n:=1}
@@ -249,7 +249,6 @@ do
done
# Did not find any free machines. Rest a bit.
- #echo "$Script: Too much load. Waiting"
sleep 1
done
--
GitLab