Clarify what tool-specific options are #3444
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ndokos
added
bug
Agent
Documentation
tools
webbnh
previously approved these changes
May 31, 2023
Member
webbnh
left a comment
webbnh
left a comment
There was a problem hiding this comment.
Looks good, although I would go with something which stands in opposition to "registration" (like "operational") instead of "generic".
dbutenhof
reviewed
May 31, 2023
Member
Author
|
OK - once more with feeling! |
webbnh
previously approved these changes
May 31, 2023
Member
webbnh
left a comment
webbnh
left a comment
There was a problem hiding this comment.
It just keeps getting better (but, there are always opportunities for improvements...).
dbutenhof
previously approved these changes
Jun 1, 2023
Member
dbutenhof
left a comment
dbutenhof
left a comment
There was a problem hiding this comment.
While I'm tempted to "request changes" for the indentation glitch, and Webb's suggestion about the tool options would help a lot with readability in those cases, I guess neither are critical so I'll approve with only slight misgivings for the sake of keeping 0.72 moving 😁 ...
Member
Author
|
Rebased and squashed. |
webbnh
reviewed
Jun 1, 2023
Member
webbnh
left a comment
webbnh
left a comment
There was a problem hiding this comment.
It looks like the strace handling needs tweaking (and there's one other tweak to make while you're at it).
Fixes distributed-system-analysis#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 of `pbench-register-tool`). PBENCH-1173
dbutenhof
approved these changes
Jun 2, 2023
ndokos
added a commit
to ndokos/pbench
that referenced
this pull request
Jun 13, 2023
) Fixes distributed-system-analysis#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 of `pbench-register-tool`). PBENCH-1173
1 task
ndokos
added a commit
to ndokos/pbench
that referenced
this pull request
Jul 3, 2023
) 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
ndokos
added a commit
to ndokos/pbench
that referenced
this pull request
Jul 3, 2023
) 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
ndokos
added a commit
that referenced
this pull request
Jul 3, 2023
Fixes #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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3443
Modify the help message of pbench-register-tool to warn against using generic options 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 generic options and which are tool-specific options.
PBENCH-1173