Repository navigation
memory: Fix DEBUG_HEAP build. - #1978
Conversation
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
@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.
Unify function naming to fix DEBUG_HEAP build Signed-off-by: Jakub Dabek <jakub.dabek@intel.com>
Rename function to fix DEBUG_HEAP build.
Signed-off-by: Jakub Dabek jakub.dabek@intel.com