Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-28 15:11:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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: David Vernet <void@manifault.com>
Acked-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20220927160559.97154-6-corbet@lwn.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Jonathan Corbet 2022-09-27 10:05:57 -06:00
parent 90c0bf89de
commit f4bf1cd4ac
4 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/asm-annotations.rst → Documentation/core-api/asm-annotations.rst
View File

@ -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
--------------------- ---------------------

1
Documentation/core-api/index.rst
View File

@ -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
======================================= =======================================

8
Documentation/index.rst
View File

@ -89,14 +89,6 @@ platform firmwares.
devicetree/index devicetree/index
Architecture-agnostic documentation
-----------------------------------
.. toctree::
:maxdepth: 1
asm-annotations
Architecture-specific documentation Architecture-specific documentation
----------------------------------- -----------------------------------

2
scripts/checkpatch.pl
View File

@ -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