STYLE: ensure help for -dict matches its intended usage

This commit is contained in:
Mark Olesen
2018-12-17 10:39:59 +01:00
parent 146bfe2b56
commit 919fa3a541
21 changed files with 41 additions and 27 deletions

View File

@ -82,7 +82,8 @@ int main(int argc, char *argv[])
"Collapse faces that are in the supplied face set" "Collapse faces that are in the supplied face set"
); );
#include "addDictOption.H" argList::addOption("dict", "file", "Use alternative collapseDict");
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
argList::noFunctionObjects(); // Never use function objects argList::noFunctionObjects(); // Never use function objects

View File

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

View File

@ -1469,7 +1469,12 @@ int main(int argc, char *argv[])
#include "addRegionOption.H" #include "addRegionOption.H"
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
#include "addDictOption.H"
argList::addOption
(
"dict", "file", "Use alternative extrudeToRegionMeshDict"
);
#include "setRootCase.H" #include "setRootCase.H"
#include "createTime.H" #include "createTime.H"
#include "createNamedMesh.H" #include "createNamedMesh.H"

View File

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

View File

@ -441,9 +441,8 @@ int main(int argc, char *argv[])
"Does not duplicate points." "Does not duplicate points."
); );
#include "addDictOption.H" argList::addOption("dict", "file", "Use alternative createBafflesDict");
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
#include "addDictOption.H"
#include "addRegionOption.H" #include "addRegionOption.H"
argList::noFunctionObjects(); // Never use function objects argList::noFunctionObjects(); // Never use function objects

View File

@ -518,7 +518,7 @@ int main(int argc, char *argv[])
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
#include "addRegionOption.H" #include "addRegionOption.H"
#include "addDictOption.H" argList::addOption("dict", "file", "Use alternative createPatchDict");
argList::addBoolOption argList::addBoolOption
( (
"writeObj", "writeObj",

View File

@ -49,9 +49,7 @@ int main(int argc, char *argv[])
"Mirrors a mesh around a given plane." "Mirrors a mesh around a given plane."
); );
#include "addDictOption.H" argList::addOption("dict", "file", "Use alternative mirrorMeshDict");
// Adjust the help text
argList::addUsage("dict", "Specify alternative mirrorMeshDict");
argList::setAdvanced("decomposeParDict"); argList::setAdvanced("decomposeParDict");
#include "addOverwriteOption.H" #include "addOverwriteOption.H"

View File

@ -162,7 +162,8 @@ int main(int argc, char *argv[])
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
#include "addRegionOption.H" #include "addRegionOption.H"
#include "addDictOption.H"
argList::addOption("dict", "file", "Use alternative refineMeshDict");
argList::addBoolOption argList::addBoolOption
( (

View File

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

View File

@ -115,7 +115,8 @@ int main(int argc, char *argv[])
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
#include "addRegionOption.H" #include "addRegionOption.H"
#include "addDictOption.H"
argList::addOption("dict", "file", "Use alternative stitchMeshDict");
argList::addBoolOption argList::addBoolOption
( (

View File

@ -207,7 +207,9 @@ int main(int argc, char *argv[])
); );
timeSelector::addOptions(true, false); // constant(true), zero(false) timeSelector::addOptions(true, false); // constant(true), zero(false)
#include "addDictOption.H"
argList::addOption("dict", "file", "Use alternative topoSetDict");
#include "addRegionOption.H" #include "addRegionOption.H"
argList::addBoolOption argList::addBoolOption
( (

View File

@ -109,7 +109,8 @@ int main(int argc, char *argv[])
argList::noCheckProcessorDirectories(); argList::noCheckProcessorDirectories();
#include "addDictOption.H" argList::addOption("dict", "file", "Use alternative noiseDict");
#include "setRootCase.H" #include "setRootCase.H"
#include "createTime.H" #include "createTime.H"

View File

@ -396,7 +396,8 @@ int main(int argc, char *argv[])
" (such as the patch type for fields and polyMesh/boundary files)." " (such as the patch type for fields and polyMesh/boundary files)."
); );
#include "addDictOption.H" argList::addOption("dict", "file", "Use alternative changeDictionaryDict");
argList::addOption argList::addOption
( (
"subDict", "subDict",

View File

@ -81,7 +81,7 @@ int main(int argc, char *argv[])
( (
"commsDir", "commsDir",
"dir", "dir",
"Specify alternate communications directory (default is 'comms')" "Specify communications directory (default is 'comms')"
); );
#include "setRootCase.H" #include "setRootCase.H"
#include "createTime.H" #include "createTime.H"

View File

@ -59,8 +59,9 @@ int main(int argc, char *argv[])
" algorithm. Writes a map of fine to coarse grid." " algorithm. Writes a map of fine to coarse grid."
); );
argList::addOption("dict", "file", "Use alternative viewFactorsDict");
#include "addRegionOption.H" #include "addRegionOption.H"
#include "addDictOption.H"
#include "setRootCase.H" #include "setRootCase.H"
#include "createTime.H" #include "createTime.H"
#include "createNamedMesh.H" #include "createNamedMesh.H"

View File

@ -401,7 +401,8 @@ int main(int argc, char *argv[])
"Set values on a selected set of cells/patch-faces via a dictionary" "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 "addRegionOption.H"
#include "setRootCase.H" #include "setRootCase.H"
#include "createTime.H" #include "createTime.H"

View File

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

View File

@ -100,7 +100,8 @@ int main(int argc, char *argv[])
"factor", "factor",
"Geometry scaling factor on output" "Geometry scaling factor on output"
); );
#include "addDictOption.H" argList::addOption("dict", "file", "Use alternative coordinateSystems");
argList::addOption argList::addOption
( (
"from", "from",

View File

@ -107,7 +107,8 @@ int main(int argc, char *argv[])
"factor", "factor",
"Geometry scaling factor on output - default is 1" "Geometry scaling factor on output - default is 1"
); );
#include "addDictOption.H" argList::addOption("dict", "file", "Use alternative coordinateSystems");
argList::addOption argList::addOption
( (
"from", "from",

View File

@ -49,7 +49,7 @@ Usage
Specify a scaling factor when writing files. Specify a scaling factor when writing files.
- \par -dict \<dictionary\> - \par -dict \<dictionary\>
Specify an alternative dictionary for constant/coordinateSystems. Use alternative dictionary for constant/coordinateSystems.
- \par -from \<coordinateSystem\> - \par -from \<coordinateSystem\>
Specify a coordinate system when reading files. Specify a coordinate system when reading files.
@ -107,7 +107,8 @@ int main(int argc, char *argv[])
"factor", "factor",
"Geometry scaling factor on output - default is 1" "Geometry scaling factor on output - default is 1"
); );
#include "addDictOption.H" argList::addOption("dict", "file", "Use alternative coordinateSystems");
argList::addOption argList::addOption
( (
"from", "from",

View File

@ -57,7 +57,7 @@ int main(int argc, char *argv[])
"Add patches (regions) to a surface with a user-selectable method" "Add patches (regions) to a surface with a user-selectable method"
); );
argList::noParallel(); argList::noParallel();
#include "addDictOption.H" argList::addOption("dict", "file", "Use alternative surfacePatchDict");
#include "setRootCase.H" #include "setRootCase.H"
#include "createTime.H" #include "createTime.H"