STYLE: ensure help for -dict matches its intended usage

2025-11-28 03:28:01 +00:00 · 2018-12-17 10:39:59 +01:00
parent 146bfe2b56
commit 919fa3a541
21 changed files with 41 additions and 27 deletions
--- a/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C
+++ b/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C
@ -82,7 +82,8 @@ int main(int argc, char *argv[])
        "Collapse faces that are in the supplied face set"
    );

-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative collapseDict");
+
    #include "addOverwriteOption.H"

    argList::noFunctionObjects();  // Never use function objects
--- a/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C
+++ b/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C
@ -342,7 +342,7 @@ int main(int argc, char *argv[])
        "For example, moving points, splitting/collapsing edges etc."
    );
    #include "addOverwriteOption.H"
-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative modifyMeshDict");

    argList::noFunctionObjects();  // Never use function objects

--- a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
+++ b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
@ -1469,7 +1469,12 @@ int main(int argc, char *argv[])

    #include "addRegionOption.H"
    #include "addOverwriteOption.H"
-    #include "addDictOption.H"
+
+    argList::addOption
+    (
+        "dict", "file", "Use alternative extrudeToRegionMeshDict"
+    );
+
    #include "setRootCase.H"
    #include "createTime.H"
    #include "createNamedMesh.H"
--- a/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C
+++ b/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C
@ -684,6 +684,7 @@ int main(int argc, char *argv[])

    #include "addRegionOption.H"
    #include "addOverwriteOption.H"
+    #include "addProfilingOption.H"
    argList::addBoolOption
    (
        "checkGeometry",
@ -707,8 +708,7 @@ int main(int argc, char *argv[])
        "file",
        "Name of the file to save the simplified surface to"
    );
-    #include "addProfilingOption.H"
-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative snappyHexMeshDict");

    argList::noFunctionObjects();  // Never use function objects

--- a/applications/utilities/mesh/manipulation/createBaffles/createBaffles.C
+++ b/applications/utilities/mesh/manipulation/createBaffles/createBaffles.C
@ -441,9 +441,8 @@ int main(int argc, char *argv[])
        "Does not duplicate points."
    );

-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative createBafflesDict");
    #include "addOverwriteOption.H"
-    #include "addDictOption.H"
    #include "addRegionOption.H"

    argList::noFunctionObjects();  // Never use function objects
--- a/applications/utilities/mesh/manipulation/createPatch/createPatch.C
+++ b/applications/utilities/mesh/manipulation/createPatch/createPatch.C
@ -518,7 +518,7 @@ int main(int argc, char *argv[])

    #include "addOverwriteOption.H"
    #include "addRegionOption.H"
-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative createPatchDict");
    argList::addBoolOption
    (
        "writeObj",
--- a/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C
+++ b/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C
@ -49,9 +49,7 @@ int main(int argc, char *argv[])
        "Mirrors a mesh around a given plane."
    );

-    #include "addDictOption.H"
-    // Adjust the help text
-    argList::addUsage("dict", "Specify alternative mirrorMeshDict");
+    argList::addOption("dict", "file", "Use alternative mirrorMeshDict");
    argList::setAdvanced("decomposeParDict");

    #include "addOverwriteOption.H"
--- a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C
+++ b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C
@ -162,7 +162,8 @@ int main(int argc, char *argv[])

    #include "addOverwriteOption.H"
    #include "addRegionOption.H"
-    #include "addDictOption.H"
+
+    argList::addOption("dict", "file", "Use alternative refineMeshDict");

    argList::addBoolOption
    (
--- a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C
+++ b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C
@ -617,7 +617,8 @@ int main(int argc, char *argv[])
    #include "addRegionOption.H"
    #include "addOverwriteOption.H"
    #include "addTimeOptions.H"
-    #include "addDictOption.H"
+
+    argList::addOption("dict", "file", "Use alternative renumberMeshDict");

    argList::addBoolOption
    (
--- a/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C
+++ b/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C
@ -115,7 +115,8 @@ int main(int argc, char *argv[])

    #include "addOverwriteOption.H"
    #include "addRegionOption.H"
-    #include "addDictOption.H"
+
+    argList::addOption("dict", "file", "Use alternative stitchMeshDict");

    argList::addBoolOption
    (
--- a/applications/utilities/mesh/manipulation/topoSet/topoSet.C
+++ b/applications/utilities/mesh/manipulation/topoSet/topoSet.C
@ -207,7 +207,9 @@ int main(int argc, char *argv[])
    );

    timeSelector::addOptions(true, false);  // constant(true), zero(false)
-    #include "addDictOption.H"
+
+    argList::addOption("dict", "file", "Use alternative topoSetDict");
+
    #include "addRegionOption.H"
    argList::addBoolOption
    (
--- a/applications/utilities/postProcessing/noise/noise.C
+++ b/applications/utilities/postProcessing/noise/noise.C
@ -109,7 +109,8 @@ int main(int argc, char *argv[])

    argList::noCheckProcessorDirectories();

-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative noiseDict");
+
    #include "setRootCase.H"
    #include "createTime.H"

--- a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
+++ b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
@ -396,7 +396,8 @@ int main(int argc, char *argv[])
        " (such as the patch type for fields and polyMesh/boundary files)."
    );

-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative changeDictionaryDict");
+
    argList::addOption
    (
        "subDict",
--- a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
+++ b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
@ -81,7 +81,7 @@ int main(int argc, char *argv[])
    (
        "commsDir",
        "dir",
-        "Specify alternate communications directory (default is 'comms')"
+        "Specify communications directory (default is 'comms')"
    );
    #include "setRootCase.H"
    #include "createTime.H"
--- a/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C
+++ b/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C
@ -59,8 +59,9 @@ int main(int argc, char *argv[])
        " algorithm. Writes a map of fine to coarse grid."
    );

+    argList::addOption("dict", "file", "Use alternative viewFactorsDict");
    #include "addRegionOption.H"
-    #include "addDictOption.H"
+
    #include "setRootCase.H"
    #include "createTime.H"
    #include "createNamedMesh.H"
--- a/applications/utilities/preProcessing/setFields/setFields.C
+++ b/applications/utilities/preProcessing/setFields/setFields.C
@ -401,7 +401,8 @@ int main(int argc, char *argv[])
        "Set values on a selected set of cells/patch-faces via a dictionary"
    );

-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative setFieldsDict");
+
    #include "addRegionOption.H"
    #include "setRootCase.H"
    #include "createTime.H"
--- a/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C
+++ b/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C
@ -274,8 +274,7 @@ int main(int argc, char *argv[])
    );
    argList::noParallel();
    argList::addArgument("hookTolerance", "The point merge tolerance");
-
-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative surfaceHookUpDict");

    #include "setRootCase.H"
    #include "createTime.H"
--- a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
+++ b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
@ -100,7 +100,8 @@ int main(int argc, char *argv[])
        "factor",
        "Geometry scaling factor on output"
    );
-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative coordinateSystems");
+
    argList::addOption
    (
        "from",
--- a/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
+++ b/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
@ -107,7 +107,8 @@ int main(int argc, char *argv[])
        "factor",
        "Geometry scaling factor on output - default is 1"
    );
-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative coordinateSystems");
+
    argList::addOption
    (
        "from",
--- a/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
+++ b/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
@ -49,7 +49,7 @@ Usage
        Specify a scaling factor when writing files.

      - \par -dict \<dictionary\>
-        Specify an alternative dictionary for constant/coordinateSystems.
+        Use alternative dictionary for constant/coordinateSystems.

      - \par -from \<coordinateSystem\>
        Specify a coordinate system when reading files.
@ -107,7 +107,8 @@ int main(int argc, char *argv[])
        "factor",
        "Geometry scaling factor on output - default is 1"
    );
-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative coordinateSystems");
+
    argList::addOption
    (
        "from",
--- a/applications/utilities/surface/surfacePatch/surfacePatch.C
+++ b/applications/utilities/surface/surfacePatch/surfacePatch.C
@ -57,7 +57,7 @@ int main(int argc, char *argv[])
        "Add patches (regions) to a surface with a user-selectable method"
    );
    argList::noParallel();
-    #include "addDictOption.H"
+    argList::addOption("dict", "file", "Use alternative surfacePatchDict");

    #include "setRootCase.H"
    #include "createTime.H"