Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The docs do not adequately explain the validate_cmd parameters #802

Open
jcbollinger opened this issue Dec 30, 2023 · 0 comments
Open

The docs do not adequately explain the validate_cmd parameters #802

jcbollinger opened this issue Dec 30, 2023 · 0 comments

Comments

@jcbollinger
Copy link

Requested change

Please update the documentation for concat::concat::validate_cmd and concat_file::validate_cmd to provide sufficient details for users to use it successfully. That could be by copying the docs of File::validate_cmd or by inserting a reference to those docs, for example.

Context / explanation

With the current docs, users have to figure out that

  • the designated command is expected to accept a file name string;
  • a % character must be included in the command string as a placeholder for the filename;
  • the command name in the string must be an absolute pathname; and
  • the command is expected to exit with status 0 to indicate validity, and non-zero to indicate invalidity.

It might be reasonable to expect advanced Puppet users to guess some of that, but why should anyone need to guess? Or to study the module source to figure it out, which is what I had to do?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants