Skip to content

memory: Fix DEBUG_HEAP build. #1978

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
tlauda merged 1 commit into from
Oct 21, 2019
Merged

memory: Fix DEBUG_HEAP build. #1978

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
2 changes: 1 addition & 1 deletion src/include/sof/lib/alloc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ void rfree(void *ptr);
} while (0); \

@dbaluta dbaluta Oct 21, 2019 •
edited
Loading

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.

Please do not add a 'dot' at the end of the commit subject. Also, please be more specific about the build failure. Maybe a small snippet of the build error.

Why renaming fixes the build?

@dabekjakub dabekjakub Oct 21, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Dots removed.
I do not know why we should go into why it is not building correctly - does it matter right now?
Function under define was not named correctly so it had to be renamed.

@dbaluta dbaluta Oct 21, 2019

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.

@dabekjakub yes we really need to go into WHY we do changes. We need to develop good habits. Imagine if for such small changes we are not writing clear commit messages what are we going to do when we will have very complex design changes?!

So, please mention in the commit message why the build failed.

@dabekjakub dabekjakub Oct 21, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@dbaluta what I mean mostly is that the change itself is self-explanatory.

The fact that the name of the function had to be changed in one place under a specific configuration clearly implies that it was defined differently in other parts of the code.

@jajanusz jajanusz Oct 21, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes description usually should tell 'why', for bigger/unclear stuff you need at least paragraph, but for simple change simple sentence is enough. We need to find good balance between being overly obsessive and not-discouraging developers

@dbaluta dbaluta Oct 21, 2019

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.

@dabekjakub

@dbaluta what I mean mostly is that the change itself is self-explanatory.

The fact that the name of the function had to be changed in one place under a specific configuration clearly implies that it was defined differently in other parts of the code.

@dabekjakub would like to see this in the commit message. It just a one line explanation.

I'm insisting on this to create a good habit on documenting the commit messages. I understand that it seems obvious for you why the change is need but it doesn't hurt to add the explanation in the commit message.

For me it's not clear for example if the build fails with "multiple redefinition" of the same function or just actually function not defined.

_ptr; })

#define rbrealloc_a(ptr, zone, caps, bytes, alignment) \
#define rbrealloc_align(ptr, zone, caps, bytes, alignment) \
({void *_ptr; \
do { \
_ptr = _brealloc(ptr, zone, caps, bytes, alignment); \
Expand Down