chore: for each command, add markdown containing help text#657
Merged
harp-intel merged 4 commits intomainfrom Mar 5, 2026
Merged
chore: for each command, add markdown containing help text#657harp-intel merged 4 commits intomainfrom
harp-intel merged 4 commits intomainfrom
Conversation
Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 pull request adds automatic generation of command documentation for the
perfspecttool and updates theREADME.mdto reference these new docs. The main changes are the introduction of a Makefile target that creates Markdown documentation for each command and subcommand, and the enhancement of the README to link to these docs for easier access to command-line options and help texts.Documentation generation and integration:
docsMakefile target that generates Markdown documentation for all main commands (report,benchmark,metrics,telemetry,flamegraph,lock,config) and selected subcommands (metrics:trim,config:restore) by extracting help text from the CLI and saving it to thedocsdirectory. (Makefile)docs/perfspect.md,docs/perfspect_benchmark.md,docs/perfspect_config.md,docs/perfspect_config_restore.md,docs/perfspect_flamegraph.md. [1] [2] [3] [4] [5]README enhancements:
README.mdto include direct links to the generated documentation for each command.