Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

+6 -12
+4 -3
Documentation/asm-annotations.rst Documentation/core-api/asm-annotations.rst
··· 43 43 information. In particular, on properly annotated objects, ``objtool`` can be 44 44 run to check and fix the object if needed. Currently, ``objtool`` can report 45 45 missing frame pointer setup/destruction in functions. It can also 46 - automatically generate annotations for :doc:`ORC unwinder <x86/orc-unwinder>` 46 + automatically generate annotations for the ORC unwinder 47 + (Documentation/x86/orc-unwinder.rst) 47 48 for most code. Both of these are especially important to support reliable 48 - stack traces which are in turn necessary for :doc:`Kernel live patching 49 - <livepatch/livepatch>`. 49 + stack traces which are in turn necessary for kernel live patching 50 + (Documentation/livepatch/livepatch.rst). 50 51 51 52 Caveat and Discussion 52 53 ---------------------
+1
Documentation/core-api/index.rst
··· 23 23 printk-formats 24 24 printk-index 25 25 symbol-namespaces 26 + asm-annotations 26 27 27 28 Data structures and low-level utilities 28 29 =======================================
-8
Documentation/index.rst
··· 89 89 devicetree/index 90 90 91 91 92 - Architecture-agnostic documentation 93 - ----------------------------------- 94 - 95 - .. toctree:: 96 - :maxdepth: 1 97 - 98 - asm-annotations 99 - 100 92 Architecture-specific documentation 101 93 ----------------------------------- 102 94
+1 -1
scripts/checkpatch.pl
··· 3751 3751 if ($realfile =~ /\.S$/ && 3752 3752 $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) { 3753 3753 WARN("AVOID_L_PREFIX", 3754 - "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); 3754 + "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); 3755 3755 } 3756 3756 3757 3757 # check we are in a valid source file C or perl if not then ignore this hunk