Skip to content

Toolchain: Add a note about weak functions and header files #4718

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
merged 1 commit into from
Jul 17, 2017
Merged

Toolchain: Add a note about weak functions and header files #4718

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
8 changes: 7 additions & 1 deletion platform/mbed_toolchain.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,15 @@

/** MBED_WEAK
* Mark a function as being weak.
*
* @note
* Functions should only be marked as weak in the source file. The header file
* should contain a regular function declaration to insure the function is emitted.
* A function marked weak will not be emitted if an alternative non-weak
* implementation is defined.
*
* @note
* weak functions are not friendly to making code re-usable, as they can only
* Weak functions are not friendly to making code re-usable, as they can only
* be overridden once (and if they are multiply overridden the linker will emit
* no warning). You should not normally use weak symbols as part of the API to
* re-usable modules.
Expand Down