Skip to content

Commit f4bf1cd

Browse files
author
Jonathan Corbet
committed
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 <[email protected]> Cc: Joe Perches <[email protected]> Reviewed-by: David Vernet <[email protected]> Acked-by: Jani Nikula <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Acked-by: Randy Dunlap <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 90c0bf8 commit f4bf1cd

File tree

4 files changed

+6
-12
lines changed

4 files changed

+6
-12
lines changed

Documentation/asm-annotations.rst renamed to Documentation/core-api/asm-annotations.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,11 @@ annotated objects like this, tools can be run on them to generate more useful
4343
information. In particular, on properly annotated objects, ``objtool`` can be
4444
run to check and fix the object if needed. Currently, ``objtool`` can report
4545
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)
4748
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).
5051

5152
Caveat and Discussion
5253
---------------------

Documentation/core-api/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ it.
2323
printk-formats
2424
printk-index
2525
symbol-namespaces
26+
asm-annotations
2627

2728
Data structures and low-level utilities
2829
=======================================

Documentation/index.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,6 @@ platform firmwares.
8989
devicetree/index
9090

9191

92-
Architecture-agnostic documentation
93-
-----------------------------------
94-
95-
.. toctree::
96-
:maxdepth: 1
97-
98-
asm-annotations
99-
10092
Architecture-specific documentation
10193
-----------------------------------
10294

scripts/checkpatch.pl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3751,7 +3751,7 @@ sub process {
37513751
if ($realfile =~ /\.S$/ &&
37523752
$line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) {
37533753
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);
37553755
}
37563756

37573757
# check we are in a valid source file C or perl if not then ignore this hunk

0 commit comments

Comments
 (0)