From 5e0a23edd591a6fcd5a6cfa7e521d27ddb71321f Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Fri, 18 Nov 2022 21:03:08 +0100
Subject: [PATCH] STYLE: compacter help information for -debug-switch etc.

---
 .../mesh/conversion/ccm/ccmToFoam/ccmToFoam.C |  6 ++---
 .../mesh/conversion/ccm/foamToCcm/foamToCcm.C |  6 ++---
 .../decomposePar/decomposePar.C               |  2 +-
 src/OpenFOAM/global/argList/argList.C         | 23 ++++++++-----------
 4 files changed, 17 insertions(+), 20 deletions(-)

diff --git a/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C b/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C
index a11603861f7..677da42c090 100644
--- a/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C
+++ b/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C
@@ -60,8 +60,8 @@ Usage
         Use numbered patch/zone (not names) directly from ccm ids.
 
       - \par -remap \<name\>
-        Use specified remapping dictionary instead of
-        <tt>constant/remapping</tt>
+        Alternative remapping dictionary
+        (default: <tt>constant/remapping</tt>)
 
       - \par -scale \<factor\>
         Specify an alternative geometry scaling factor.
@@ -121,7 +121,7 @@ int main(int argc, char *argv[])
     (
         "remap",
         "name",
-        "Use specified remapping dictionary instead of <constant/remapping>"
+        "Alternative remapping dictionary (default: 'constant/remapping')"
     );
     argList::addOption
     (
diff --git a/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C b/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C
index 59905b162cc..88dd59676d4 100644
--- a/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C
+++ b/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C
@@ -46,8 +46,8 @@ Usage
         No backup of existing output files.
 
       - \par -remap \<name\>
-        Use specified remapping dictionary instead of
-        <tt>constant/remapping</tt>
+        Alternative remapping dictionary
+        (default: <tt>constant/remapping</tt>)
 
       - \par -results
         Convert results only to CCM format
@@ -110,7 +110,7 @@ int main(int argc, char *argv[])
     (
         "remap",
         "name",
-        "Use specified remapping dictionary instead of <constant/remapping>"
+        "Alternative remapping dictionary (default: 'constant/remapping')"
     );
     argList::addBoolOption
     (
diff --git a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
index 1758e484afa..b9931183214 100644
--- a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
+++ b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
@@ -314,7 +314,7 @@ int main(int argc, char *argv[])
     (
         "decomposeParDict",
         "file",
-        "Use specified file for decomposePar dictionary"
+        "Alternative decomposePar dictionary file"
     );
 
     #include "addAllRegionOptions.H"
diff --git a/src/OpenFOAM/global/argList/argList.C b/src/OpenFOAM/global/argList/argList.C
index 18fc14f7b3c..19e739f5698 100644
--- a/src/OpenFOAM/global/argList/argList.C
+++ b/src/OpenFOAM/global/argList/argList.C
@@ -76,14 +76,14 @@ Foam::argList::initValidTables::initValidTables()
     (
         "case",
         "dir",
-        "Specify case directory to use (instead of cwd)"
+        "Case directory (instead of current directory)"
     );
     argList::addOption
     (
         "lib",
         "name",
-        "Additional library or library list to load."
-        " (Can be used multiple times)",
+        "Additional library or library list to load.\n"
+        "[Can be used multiple times]",
         true  // advanced option
     );
     argList::addBoolOption
@@ -97,9 +97,8 @@ Foam::argList::initValidTables::initValidTables()
     (
         "debug-switch",
         "name=val",
-        "Specify the value of a registered debug switch."
-        " Default is 1 if the value is omitted."
-        " (Can be used multiple times)",
+        "Set named DebugSwitch (default value: 1).\n"
+        "[Can be used multiple times]",
         true  // advanced option
     );
 
@@ -107,9 +106,8 @@ Foam::argList::initValidTables::initValidTables()
     (
         "info-switch",
         "name=val",
-        "Specify the value of a registered info switch."
-        " Default is 1 if the value is omitted."
-        " (Can be used multiple times)",
+        "Set named InfoSwitch (default value: 1).\n"
+        "[Can be used multiple times]",
         true  // advanced option
     );
 
@@ -117,9 +115,8 @@ Foam::argList::initValidTables::initValidTables()
     (
         "opt-switch",
         "name=val",
-        "Specify the value of a registered optimisation switch."
-        " Default is 1 if the value is omitted."
-        " (Can be used multiple times)",
+        "Set named OptimisationSwitch (default value: 1).\n"
+        "[Can be used multiple times]",
         true  // advanced option
     );
 
@@ -142,7 +139,7 @@ Foam::argList::initValidTables::initValidTables()
     (
         "decomposeParDict",
         "file",
-        "Use specified file for decomposePar dictionary"
+        "Alternative decomposePar dictionary file"
     );
     argList::addOption
     (
-- 
GitLab