linux-kernel - Re: [PATCH v2 5/7] docs: move asm-annotations.rst into core-api

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Sun, 25 Sep 2022 10:54:14 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Linux MM and miscellaneous subsystems list 
        <linux-mm@...ck.org>, Thorsten Leemhuis <linux@...mhuis.info>,
        Kees Cook <keescook@...omium.org>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        Jiri Slaby <jirislaby@...nel.org>,
        Andy Whitcroft <apw@...onical.com>,
        Joe Perches <joe@...ches.com>,
        Dwaipayan Ray <dwaipayanray1@...il.com>,
        Lukas Bulwahn <lukas.bulwahn@...il.com>
Subject: Re: [PATCH v2 5/7] docs: move asm-annotations.rst into core-api

On Thu, Sep 22, 2022 at 02:41:36PM -0600, Jonathan Corbet wrote:
> 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).
>  

Hi jon,

kernel test robot reported non-existent reference ([1]), so I have
applied the fixup:

---- >8 ----

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 79e759aac543b8..812af52f97d2cf 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

Thanks.

[1]: https://lore.kernel.org/linux-doc/202209240904.XQP4YAP7-lkp@intel.com/

-- 
An old man doll... just what I always wanted! - Clara

Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)