Skip to content

kpb: fix broken doxygen link to kpbm-state-diagram #2742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgirdwood merged 1 commit into from
Apr 8, 2020
Merged

kpb: fix broken doxygen link to kpbm-state-diagram #2742

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions src/include/sof/audio/kpb.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,9 @@ struct comp_buffer;
* the sof-dosc in [kpbm-state-diagram]
Copy link
Collaborator

@dbaluta dbaluta Apr 8, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@marc-hb I would rather add the git commit id inside commit message because it would be one git log away from the reader.

Also, use the Fixes tag.
e.g Fixes: abcdef ("Commit subject of abdef")

Copy link
Collaborator Author

@marc-hb marc-hb Apr 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

* Therefore any addition of new states or modification of existing ones
* should have a corresponding update in the sof-docs.
* [kpbm-state-diagram]: https://thesofproject.github.io/latest/
* developer_guides/firmware/kd_integration/
* kd-integration.html#kpbm-state-diagram "Keyphrase buffer manager state
* diagram"
* [kpbm-state-diagram]:
https://thesofproject.github.io/latest/developer_guides/firmware/kd_integration/kd-integration.html#kpbm-state-diagram
"Keyphrase buffer manager state diagram"
*/
enum kpb_state {
KPB_STATE_DISABLED = 0,
Expand Down