Commit 6535a39f authored by Will Deacon's avatar Will Deacon Committed by Jonathan Corbet

Documentation: Call out example SYM_FUNC_* usage as x86-specific

The example given in asm-annotations.rst to describe the constraints that
a function should meet in order to be annotated with a SYM_FUNC_* macro
is x86-specific, and not necessarily applicable to architectures using
branch-and-link style calling conventions such as arm64.

Tweak the example text to call out the x86-specific text.

Cc: Mark Brown <broonie@kernel.org>
Cc: Jiri Slaby <jslaby@suse.com>
Signed-off-by: default avatarWill Deacon <will@kernel.org>
Link: https://lore.kernel.org/r/20200115184305.1187-1-will@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 61f00590
...@@ -73,10 +73,11 @@ The new macros are prefixed with the ``SYM_`` prefix and can be divided into ...@@ -73,10 +73,11 @@ The new macros are prefixed with the ``SYM_`` prefix and can be divided into
three main groups: three main groups:
1. ``SYM_FUNC_*`` -- to annotate C-like functions. This means functions with 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 standard C calling conventions. For example, on x86, this means that the
the predefined place and a return from the function can happen in a stack contains a return address at the predefined place and a return from
standard way. When frame pointers are enabled, save/restore of frame the function can happen in a standard way. When frame pointers are enabled,
pointer shall happen at the start/end of a function, respectively, too. 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 Checking tools like ``objtool`` should ensure such marked functions conform
to these rules. The tools can also easily annotate these functions with to these rules. The tools can also easily annotate these functions with
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment