elektraGetOptsHelpMessage docs/examples use 'opt/arg/name' instead of 'opt/arg/help'

[hannes99]

Steps to Reproduce the Problem

...
(ks, keyNew (baseKeyName "spec:/test/path", KEY_META, "description", "Some description",  \
                                            KEY_META, "opt", "p", \
                                            KEY_META, "opt/arg/name", "path", \
                                            KEY_META, "opt/long", "path", \
                                            KEY_META, "opt/arg", "required", KEY_END));  \
...
... elektraGetOpts (ks, argc, (const char **) argv, (const char **) environ, errorKey);
...
char * help = elektraGetOptsHelpMessage (errorKey, NULL, NULL);

The --help output ignores the specified opt/arg/name and always uses ARG instead.

Expected Result

OPTIONS
...
  -p path, --profile=path     Some description.
...

Actual Result

OPTIONS
...
  -p ARG, --profile=ARG       Some description.
...

[kodebach]

Could you try with opt/arg/help instead?

I think that's what is actually used. See

libelektra/src/libs/opts/opts.c

Lines 781 to 783 in d57703b

	strncat (metaBuffer, "/arg/help", 11); // 11 = remaining space in metaBuffer
	const char * argNameMeta = keyGetMetaString (key, metaBuffer);

libelektra/src/libs/opts/opts.c

Line 823 in d57703b

optionData->argName = argNameMeta;

libelektra/src/libs/opts/opts.c

Line 925 in d57703b

const char * argName = optionData->argName;

libelektra/src/libs/opts/opts.c

Lines 971 to 992 in d57703b

	if (!hidden)
	{
	char * argString = "";
	if (elektraStrCmp (hasArg, "required") == 0)
	{
	argString = argName == NULL ? "=ARG" : elektraFormat ("=%s", argName);
	}
	else if (elektraStrCmp (hasArg, "optional") == 0)
	{
	argString = argName == NULL ? "=[ARG]" : elektraFormat ("=[%s]", argName);
	}
	char * newLongOptLine = elektraFormat ("%s--%s%s, ", *longOptLine, longOpt, argString);
	elektraFree (*longOptLine);
	if (argName != NULL)
	{
	elektraFree (argString);
	}
	*longOptLine = newLongOptLine;
	}

[hannes99]

Actually, yes. I'll update the rm example in the tutorial[1], since /name is used there.

[1] https://www.libelektra.org/tutorials/command-line-options#examples

[hannes99]

should I change the Issue title and description, or leave it?

[kodebach]

I'll update the rm example in the tutorial

Please also check other docs, like examples/opts.c and examples/gopts.c

should I change the Issue title and description, or leave it?

I updated it.