Skip to content

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

Merged
lgirdwood merged 1 commit into
thesofproject:masterfrom
marc-hb:kpb-doxygen-broken-link
Apr 8, 2020
Merged

kpb: fix broken doxygen link to kpbm-state-diagram#2742
lgirdwood merged 1 commit into
thesofproject:masterfrom
marc-hb:kpb-doxygen-broken-link

Conversation

@marc-hb

@marc-hbmarc-hb commented Apr 8, 2020

Copy link
Copy Markdown
Collaborator

As reported by PR #2741:

sof/src/include/sof/audio/kpb.h:46: warning: explicit link request to 'kpbm' could not be resolved

Fixes: 36d4c9f ("kpb: add new state")

Signed-off-by: Marc Herbert marc.herbert@intel.com

@marc-hb
marc-hb requested a review from mrajwa as a code ownerApril 8, 2020 05:58

@monocodusmonocodusBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is autogenerated code-style review, all good, approving

Comment threadsrc/include/sof/audio/kpb.h Outdated

@dbalutadbalutaApr 8, 2020

Copy link
Copy Markdown
Collaborator

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
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Done

@marc-hb

Copy link
Copy Markdown
CollaboratorAuthor

Doxygen output is not published anywhere, is it? @deb-intel? I didn't find it at https://thesofproject.github.io/latest/api/index.html . It's only used as an input to breathe?

Anyway I checked the doxygen output locally and this does fix the broken link; not just the warning.

@marc-hb
marc-hbforce-pushed the kpb-doxygen-broken-link branch from c9f589b to 852449dCompareApril 8, 2020 06:56

@monocodusmonocodusBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is autogenerated code-style review, all good, approving

As reported by PR thesofproject#2741:
sof/src/include/sof/audio/kpb.h:46: warning: explicit link request to 'kpbm' could not be resolved
Fixes: 36d4c9f ("kpb: add new state")
Signed-off-by: Marc Herbert <marc.herbert@intel.com>
@marc-hb
marc-hbforce-pushed the kpb-doxygen-broken-link branch from 852449d to aa994d0CompareApril 8, 2020 06:57

@monocodusmonocodusBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is autogenerated code-style review, all good, approving

@monocodusmonocodusBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is autogenerated code-style review, all good, approving

@lgirdwood

Copy link
Copy Markdown
Member

CI known issues

@lgirdwood
lgirdwood merged commit b2b4abf into thesofproject:masterApr 8, 2020
@marc-hb
marc-hb deleted the kpb-doxygen-broken-link branch April 9, 2020 07:10
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@marc-hb@lgirdwood@dbaluta