global: remove function names from logging format strings #10155
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
Zephyr adds function names to log entries by itself, no need to specify them in format strings additionally. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Remove verbatim function names under src/schedule, src/math, src/init, src/idc. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Remove verbatim function names for eq_fir. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Remove verbatim function names for asrc. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Remove verbatim function names for tensorflow, google, eq_iir. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Remove verbatim function names for aria, dcblock, smart_amp, copier, selector. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Remove verbatim function names for up_down_mixer, mixin_mixout, codec, crossover. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Remove verbatim function names for mfcc, rtnr, mux, src, module_adapter. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Remove verbatim function names for pipeline, drc, igo_nr, volume, multiband_drc, buffers, tdfb. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Remove verbatim function names for src/audio. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
lyakh
requested review from
a team,
LaurentiuM1234,
RanderWang,
abonislawski,
bardliao,
dbaluta,
fkwasowi,
jxstelter,
kv2019i,
lbetlej,
lgirdwood,
marcinszkudlinski,
mmaka1,
pblaszko,
plbossart,
ranj063,
singalsu and
tlissows
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR removes redundant function names from logging format strings across the codebase. The change leverages Zephyr's automatic function name logging capability to eliminate verbose duplication in log messages.
- Removes function name prefixes from log format strings (e.g., "function(): message" becomes just "message")
- Standardizes entry point logging to use "entry" instead of function names
- Applies changes consistently across IPC, audio components, and scheduling modules
Reviewed Changes
Copilot reviewed 82 out of 82 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/schedule/*.c | Remove function names from scheduler and domain logging |
| src/ipc/*.c | Clean up IPC handler and helper function log messages |
| src/audio//.c | Update audio component logging across volume, EQ, DRC, and other modules |
| src/audio/pipeline/*.c | Simplify pipeline management logging |
| src/audio/module_adapter/*.c | Update module adapter and codec logging |
|
|
||
| if (md->state != MODULE_IDLE) { | ||
| comp_err(dev, "module_process(): wrong state of comp_id %x, state %d", | ||
| comp_err(dev, "wrong state of comp_id %x, state %d", |
There was a problem hiding this comment.
[nitpick] Consider using the standardized 'comp %x' format instead of 'comp_id %x' for consistency with other error messages in the codebase.
Suggested change
| comp_err(dev, "wrong state of comp_id %x, state %d", | |
| comp_err(dev, "wrong state of comp %x, state %d", |
marcinszkudlinski
approved these changes
Aug 7, 2025
lgirdwood
approved these changes
Aug 7, 2025
Member
|
@lrudyX not expecting build to fail as its passed in other tests ? |
tmleman
approved these changes
Aug 7, 2025
Collaborator
Author
|
obviously, this PR wasn't created manually, and it wasn't perfect - it left a lot of those function names in logs behind. For reference I used to find all those left-overs - only under sof/src - that line found 1300 of them (after I've removed a few more manually, so actually there are more). Some of them are false positives, but not many. To Be Continued. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Zephyr adds function names to log entries automatically, remove excessive verbatim names globally