Commit f4bf1cd4 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

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.net


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 90c0bf89

Documentation/asm-annotations.rst→Documentation/core-api/asm-annotations.rst

+4 −3
Original line number Diff line number Diff line
@@ -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

run to check and fix the object if needed. Currently, ``objtool`` can report

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

stack traces which are in turn necessary for :doc:`Kernel live patching

<livepatch/livepatch>`.

stack traces which are in turn necessary for kernel live patching

(Documentation/livepatch/livepatch.rst).



Caveat and Discussion

---------------------

Documentation/core-api/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -23,6 +23,7 @@ it. 
   printk-formats

   printk-index

   symbol-namespaces

   asm-annotations



Data structures and low-level utilities

=======================================

Documentation/index.rst

+0 −8
Original line number Diff line number Diff line
@@ -89,14 +89,6 @@ platform firmwares. 
   devicetree/index





Architecture-agnostic documentation

-----------------------------------



.. toctree::

   :maxdepth: 1



   asm-annotations



Architecture-specific documentation

-----------------------------------

scripts/checkpatch.pl

+1 −1
Original line number Diff line number Diff line
@@ -3751,7 +3751,7 @@ sub process { 
		if ($realfile =~ /\.S$/ &&

		    $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) {

			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