diff options
| author | Will Deacon <will@kernel.org> | 2020-01-15 18:43:05 +0000 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2020-01-16 12:53:16 -0700 |
| commit | 6535a39ffa88d24e7b277737e6a7405181f68710 (patch) | |
| tree | 28a2e3a93cfcbaa3a2a7ef2a26205e2bcac727dc /Documentation | |
| parent | 61f005901b73786893c36d08cd1152fb89683651 (diff) | |
| download | linux-stable-6535a39ffa88d24e7b277737e6a7405181f68710.tar.gz linux-stable-6535a39ffa88d24e7b277737e6a7405181f68710.tar.bz2 linux-stable-6535a39ffa88d24e7b277737e6a7405181f68710.zip | |
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: Will Deacon <will@kernel.org>
Link: https://lore.kernel.org/r/20200115184305.1187-1-will@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/asm-annotations.rst | 9 |
1 files changed, 5 insertions, 4 deletions
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 |