From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org,
Thorsten Leemhuis <linux@leemhuis.info>,
Kees Cook <keescook@chromium.org>,
Jani Nikula <jani.nikula@linux.intel.com>,
Joe Perches <joe@perches.com>, David Vernet <void@manifault.com>,
Jonathan Corbet <corbet@lwn.net>,
Jiri Slaby <jirislaby@kernel.org>,
Jani Nikula <jani.nikula@intel.com>
Subject: [PATCH v3 5/7] docs: move asm-annotations.rst into core-api
Date: Tue, 27 Sep 2022 10:05:57 -0600 [thread overview]
Message-ID: <20220927160559.97154-6-corbet@lwn.net> (raw)
In-Reply-To: <20220927160559.97154-1-corbet@lwn.net>
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>
---
Documentation/{ => core-api}/asm-annotations.rst | 7 ++++---
Documentation/core-api/index.rst | 1 +
Documentation/index.rst | 8 --------
scripts/checkpatch.pl | 2 +-
4 files changed, 6 insertions(+), 12 deletions(-)
rename Documentation/{ => core-api}/asm-annotations.rst (97%)
diff --git a/Documentation/asm-annotations.rst b/Documentation/core-api/asm-annotations.rst
similarity index 97%
rename from Documentation/asm-annotations.rst
rename to Documentation/core-api/asm-annotations.rst
index a64f2ca469d4..bc514ed59887 100644
--- a/Documentation/asm-annotations.rst
+++ b/Documentation/core-api/asm-annotations.rst
@@ -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
---------------------
diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index dc95df462eea..f5d8e3779fe8 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -23,6 +23,7 @@ it.
printk-formats
printk-index
symbol-namespaces
+ asm-annotations
Data structures and low-level utilities
=======================================
diff --git a/Documentation/index.rst b/Documentation/index.rst
index da80c584133c..5a700548ae82 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -89,14 +89,6 @@ platform firmwares.
devicetree/index
-Architecture-agnostic documentation
------------------------------------
-
-.. toctree::
- :maxdepth: 1
-
- asm-annotations
-
Architecture-specific documentation
-----------------------------------
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 79e759aac543..812af52f97d2 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -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
--
2.37.2
next prev parent reply other threads:[~2022-09-27 16:08 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-27 16:05 [PATCH v3 0/7] Rewrite the top-level index.rst Jonathan Corbet
2022-09-27 16:05 ` [PATCH v3 1/7] docs: promote the title of process/index.rst Jonathan Corbet
2022-09-27 16:05 ` [PATCH v3 2/7] docs: Rewrite the front page Jonathan Corbet
2022-09-28 3:32 ` Bagas Sanjaya
2022-09-27 16:05 ` [PATCH v3 3/7] docs: reconfigure the HTML left column Jonathan Corbet
2022-09-27 16:05 ` [PATCH v3 4/7] docs: remove some index.rst cruft Jonathan Corbet
2022-09-27 16:05 ` Jonathan Corbet [this message]
2022-09-27 16:05 ` [PATCH v3 6/7] docs: put atomic*.txt and memory-barriers.txt into the core-api book Jonathan Corbet
2022-09-27 19:26 ` David Vernet
2022-09-27 16:05 ` [PATCH v3 7/7] docs: add a man-pages link to the front page Jonathan Corbet
2022-09-27 19:28 ` David Vernet
2022-09-28 6:21 ` Thorsten Leemhuis
2022-09-28 15:03 ` Randy Dunlap
2022-09-28 21:00 ` Jonathan Corbet
2022-09-27 16:21 ` [PATCH v3 0/7] Rewrite the top-level index.rst Joe Perches
2022-09-27 20:59 ` Randy Dunlap
2022-09-29 15:34 ` Jonathan Corbet
2022-09-29 15:59 ` Kees Cook
2022-09-29 17:31 ` Jonathan Corbet
2022-09-29 19:28 ` Jonathan Corbet
2022-09-29 17:47 ` Miguel Ojeda
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220927160559.97154-6-corbet@lwn.net \
--to=corbet@lwn.net \
--cc=jani.nikula@intel.com \
--cc=jani.nikula@linux.intel.com \
--cc=jirislaby@kernel.org \
--cc=joe@perches.com \
--cc=keescook@chromium.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@leemhuis.info \
--cc=void@manifault.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).