Add comprehensive help documentation to all kci-dev commands #172
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
added 9 commits
June 9, 2025 20:15
…mprove command documentation - Display help instead of error when command is run without options - Add comprehensive help text with usage examples - Improve option descriptions with clearer explanations - Specify that --filter and --field options can be used multiple times Signed-off-by: Sasha Levin <sashal@kernel.org>
…mmand documentation - Display help instead of error when command is run without options - Add comprehensive help text with usage examples - Improve option descriptions with clearer explanations and examples - Document that bisection state is saved and can be resumed - Specify that filter options can be used multiple times Signed-off-by: Sasha Levin <sashal@kernel.org>
…command documentation - Display help instead of error when command is run without options - Add comprehensive help text with usage examples - Improve option descriptions with clearer explanations - Document requirement for either --commit or --tipoftree - Specify that filter options can be used multiple times Signed-off-by: Sasha Levin <sashal@kernel.org>
…mmand documentation - Display help when run without options outside a git repository - Add comprehensive help text with usage examples - Improve option descriptions with clearer explanations - Document that command is experimental - Add note about API integration status Signed-off-by: Sasha Levin <sashal@kernel.org>
- Add comprehensive help text explaining the command purpose - Include usage examples for different scenarios - Clarify default behavior and file locations - Improve option description with better formatting Signed-off-by: Sasha Levin <sashal@kernel.org>
- Add comprehensive help text explaining patch testing functionality - Include usage examples for different scenarios - Clarify support for both patch and mbox files - Improve option descriptions with defaults and better formatting Signed-off-by: Sasha Levin <sashal@kernel.org>
…roup documentation - Display help instead of error when command group is run without subcommand - Add comprehensive help text with list of available subcommands - Include usage examples for common scenarios - Make group invoke without command to enable help display Signed-off-by: Sasha Levin <sashal@kernel.org>
- Add comprehensive help text explaining test retry functionality - Include usage examples showing how to get node IDs - Clarify when and why to use test retries - Improve option description with better context Signed-off-by: Sasha Levin <sashal@kernel.org>
- Add comprehensive help text explaining real-time job monitoring - Include usage examples for different watching scenarios - Clarify when to use watch command - Improve option descriptions with examples - Specify that job-filter can be used multiple times Signed-off-by: Sasha Levin <sashal@kernel.org>
Member
|
Thanks for improving kci-dev documentation! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR adds detailed help text with usage examples to all kci-dev commands.
What changed:
Commands updated: bisect, checkout, commit, config, patch, results, testretry, watch