On Thu, Sep 22, 2022 at 02:41:36PM -0600, Jonathan Corbet wrote: > @@ -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). Hi jon, I think Sphinx internal references are better fit for these links: ---- >8 ---- diff --git a/Documentation/core-api/asm-annotations.rst b/Documentation/core-api/asm-annotations.rst index bc514ed598870c..d3071f131dad73 100644 --- a/Documentation/core-api/asm-annotations.rst +++ b/Documentation/core-api/asm-annotations.rst @@ -43,11 +43,10 @@ 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 the ORC unwinder -(Documentation/x86/orc-unwinder.rst) +automatically generate annotations for the :ref:`ORC unwinder <orc-unwinder>` for most code. Both of these are especially important to support reliable -stack traces which are in turn necessary for kernel live patching -(Documentation/livepatch/livepatch.rst). +stack traces which are in turn necessary for :ref:`kernel live patching +<kernel-livepatch>`. Caveat and Discussion --------------------- diff --git a/Documentation/livepatch/livepatch.rst b/Documentation/livepatch/livepatch.rst index 68e3651e8af925..ebb8b05a9b0d3e 100644 --- a/Documentation/livepatch/livepatch.rst +++ b/Documentation/livepatch/livepatch.rst @@ -1,3 +1,5 @@ +.. _kernel-livepatch: + ========= Livepatch ========= diff --git a/Documentation/x86/orc-unwinder.rst b/Documentation/x86/orc-unwinder.rst index cdb257015bd9e8..b26368c3892d3d 100644 --- a/Documentation/x86/orc-unwinder.rst +++ b/Documentation/x86/orc-unwinder.rst @@ -1,5 +1,7 @@ .. SPDX-License-Identifier: GPL-2.0 +.. _orc-unwinder: + ============ ORC unwinder ============ Thanks. -- An old man doll... just what I always wanted! - Clara
Attachment:
signature.asc
Description: PGP signature
