Clarify what tool-specific options are (Forward port of #3444 from b0.72 to main) #3462
Conversation
There was a problem hiding this comment.
I'm feeling favorably disposed toward Dave's suggestion: since the "operational" options are not intended for end-users, perhaps they should be omitted or hidden from the tools' help output (at least by default). (There are several ways to do this properly, but probably none of them are worth the effort...so we probably should just comment them out.)
Short of that, we should probably pick a word other than "should", which is a little strong. Perhaps "may" would work, or we could add some weasel words like "as appropriate". And, there are at least two places where we should disentangle the "registration options" from the "operational" ones.
But, I'm not going to insist on holding the merge for these....
) Fixes distributed-system-analysis#3443 Modify the help message of base-tool (and everybody who is symlinked to it) to clarify the tool-specific options that may be specified when registering a tool (on the RHS of `--` in the invocation of `pbench-register-tool`). PBENCH-1173
Fixes #3443
Modify the help message of pbench-register-tool to warn against using operational options (i.e. options used internally by pbench) for a tool when it is registered.
Modify the help message of base-tool (and everybody who is symlinked to it) to clarify which are operational options and which are tool-specific options: operational options should not be specified when registering a tool: they are used by pbench internally; only tool-specific options are specifed when registering the tool (on the RHS of
--in the invocation ofpbench-register-tool).PBENCH-1173