Commit f4bf1cd4 authored by Jonathan Corbet's avatar Jonathan Corbet

docs: move asm-annotations.rst into core-api

This one file should not really be in the top-level documentation
directory.  core-api/ may not be a perfect fit but seems to be best, so
move it there.  Adjust a couple of internal document references to make
them location-independent, and point checkpatch.pl at the new location.

Cc: Jiri Slaby <jirislaby@kernel.org>
Cc: Joe Perches <joe@perches.com>
Reviewed-by: default avatarDavid Vernet <void@manifault.com>
Acked-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20220927160559.97154-6-corbet@lwn.netSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 90c0bf89
...@@ -43,10 +43,11 @@ annotated objects like this, tools can be run on them to generate more useful ...@@ -43,10 +43,11 @@ annotated objects like this, tools can be run on them to generate more useful
information. In particular, on properly annotated objects, ``objtool`` can be information. In particular, on properly annotated objects, ``objtool`` can be
run to check and fix the object if needed. Currently, ``objtool`` can report run to check and fix the object if needed. Currently, ``objtool`` can report
missing frame pointer setup/destruction in functions. It can also missing frame pointer setup/destruction in functions. It can also
automatically generate annotations for :doc:`ORC unwinder <x86/orc-unwinder>` automatically generate annotations for the ORC unwinder
(Documentation/x86/orc-unwinder.rst)
for most code. Both of these are especially important to support reliable for most code. Both of these are especially important to support reliable
stack traces which are in turn necessary for :doc:`Kernel live patching stack traces which are in turn necessary for kernel live patching
<livepatch/livepatch>`. (Documentation/livepatch/livepatch.rst).
Caveat and Discussion Caveat and Discussion
--------------------- ---------------------
......
...@@ -23,6 +23,7 @@ it. ...@@ -23,6 +23,7 @@ it.
printk-formats printk-formats
printk-index printk-index
symbol-namespaces symbol-namespaces
asm-annotations
Data structures and low-level utilities Data structures and low-level utilities
======================================= =======================================
......
...@@ -89,14 +89,6 @@ platform firmwares. ...@@ -89,14 +89,6 @@ platform firmwares.
devicetree/index devicetree/index
Architecture-agnostic documentation
-----------------------------------
.. toctree::
:maxdepth: 1
asm-annotations
Architecture-specific documentation Architecture-specific documentation
----------------------------------- -----------------------------------
......
...@@ -3751,7 +3751,7 @@ sub process { ...@@ -3751,7 +3751,7 @@ sub process {
if ($realfile =~ /\.S$/ && if ($realfile =~ /\.S$/ &&
$line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) { $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) {
WARN("AVOID_L_PREFIX", WARN("AVOID_L_PREFIX",
"Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/asm-annotations.rst\n" . $herecurr); "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/core-api/asm-annotations.rst\n" . $herecurr);
} }
# check we are in a valid source file C or perl if not then ignore this hunk # check we are in a valid source file C or perl if not then ignore this hunk
......
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