X-Git-Url: http://git.monstr.eu/?a=blobdiff_plain;f=Documentation%2Fasm-annotations.rst;h=32ea57483378ddeea5edc84278fe3d412920fcc5;hb=bd5c2344f9eb1ebf7ff2501ddb13d83151939780;hp=f55c2bb74d006bd0409f79a88b9078c29d9665a5;hpb=0aecba6173216931c436a03183f4759a4fd4c2f2;p=linux-2.6-microblaze.git diff --git a/Documentation/asm-annotations.rst b/Documentation/asm-annotations.rst index f55c2bb74d00..32ea57483378 100644 --- a/Documentation/asm-annotations.rst +++ b/Documentation/asm-annotations.rst @@ -73,10 +73,11 @@ The new macros are prefixed with the ``SYM_`` prefix and can be divided into three main groups: 1. ``SYM_FUNC_*`` -- to annotate C-like functions. This means functions with - standard C calling conventions, i.e. the stack contains a return address at - the predefined place and a return from the function can happen in a - standard way. When frame pointers are enabled, save/restore of frame - pointer shall happen at the start/end of a function, respectively, too. + standard C calling conventions. For example, on x86, this means that the + stack contains a return address at the predefined place and a return from + the function can happen in a standard way. When frame pointers are enabled, + save/restore of frame pointer shall happen at the start/end of a function, + respectively, too. Checking tools like ``objtool`` should ensure such marked functions conform to these rules. The tools can also easily annotate these functions with