Skip to content

Commit a9ae57b

Browse files
authored
Merge pull request #67 from tynanford/master
Add usage msg to addReccasterEnvVars iocsh func
2 parents 73d44e2 + 4d6ee15 commit a9ae57b

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

client/castApp/src/castinit.c

+11-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,17 @@ void addReccasterEnvVars(caster_t* self, int argc, char **argv)
184184

185185
static const iocshArg addReccasterEnvVarsArg0 = { "environmentVar", iocshArgArgv };
186186
static const iocshArg * const addReccasterEnvVarsArgs[] = { &addReccasterEnvVarsArg0 };
187-
static const iocshFuncDef addReccasterEnvVarsFuncDef = { "addReccasterEnvVars", 1, addReccasterEnvVarsArgs };
187+
static const iocshFuncDef addReccasterEnvVarsFuncDef = {
188+
"addReccasterEnvVars",
189+
1,
190+
addReccasterEnvVarsArgs,
191+
#ifdef IOCSHFUNCDEF_HAS_USAGE
192+
"Reccaster has a default list of environment variables it sends on IOC startup.\n"
193+
"This function will append extra variables to that default list.\n"
194+
"Must be called before iocInit\n"
195+
"Example: addReccasterEnvVars 'SECTOR' 'BUILDING'\n"
196+
#endif
197+
};
188198
static void addReccasterEnvVarsCallFunc(const iocshArgBuf *args)
189199
{
190200
addReccasterEnvVars(&thecaster, args[0].aval.ac, args[0].aval.av);

0 commit comments

Comments
 (0)