Documentation: document gprof command.#18979
Merged
Merged
Conversation
Add documentation for the gprof command, which controls NuttX function-call profiling. Covers the start, stop, dump, and help subcommands, configuration dependencies on CONFIG_PROFILE and CONFIG_SYSTEM_GPROF, and a worked example showing how to collect and analyse a gmon.out file. Refs apache#11081 Signed-off-by: hanzj <hanzhijian@zepp.com>
github-actions
Bot
added
Area: Documentation
acassis
approved these changes
May 27, 2026
cederom
approved these changes
May 28, 2026
Contributor
cederom
left a comment
cederom
left a comment
There was a problem hiding this comment.
Thank you @Zepp-Hanzj :-)
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
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.
Summary
Add documentation for the
gprofcommand, which controls NuttX function-call profiling. Covers thestart,stop,dump, andhelpsubcommands, configuration dependencies onCONFIG_PROFILEandCONFIG_SYSTEM_GPROF, and a worked example showing how to collect and analyse agmon.outfile.Refs #11081
Source verification
Evidence drawn from:
apps/system/gprof/gprof.c(85 lines; 3 subcommands dispatched viastrcmp)apps/system/gprof/Kconfig(tristate; depends on!PROFILE_NONE || SIM_GPROF)include/sys/gmon.h(monstartup(),moncontrol(),_mcleanup()prototypes and semantics)Docs build
Signed-off-by: hanzj hanzhijian@zepp.com