linux-kernel - Re: [PATCH] Documentation: riscv: Fix typo MIMPLID -> MIMPID

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]

Message-ID: <20240929153305.m8IHY_7l@linutronix.de>
Date: Sun, 29 Sep 2024 17:33:05 +0200
From: Nam Cao <namcao@...utronix.de>
To: Jonathan Corbet <corbet@....net>
Cc: Paul Walmsley <paul.walmsley@...ive.com>,
	Palmer Dabbelt <palmer@...belt.com>,
	Albert Ou <aou@...s.berkeley.edu>,
	Clément Léger <cleger@...osinc.com>,
	Evan Green <evan@...osinc.com>,
	Charlie Jenkins <charlie@...osinc.com>,
	Andrew Jones <ajones@...tanamicro.com>, linux-doc@...r.kernel.org,
	linux-riscv@...ts.infradead.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] Documentation: riscv: Fix typo MIMPLID -> MIMPID

On Wed, Sep 25, 2024 at 12:02:39PM -0600, Jonathan Corbet wrote:
> Nam Cao <namcao@...utronix.de> writes:
> 
> > The macro that is really defined is RISCV_HWPROBE_KEY_MIMPID, not
> > RISCV_HWPROBE_KEY_MIMPLID (difference is the 'L').
> >
> > Also, the riscv privileged specification names the register "mimpid", not
> > "mimplid".
> >
> > Correct these typos.
> >
> > Signed-off-by: Nam Cao <namcao@...utronix.de>
> > ---
> > ask me how I found out..
> >
> >  Documentation/arch/riscv/hwprobe.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/arch/riscv/hwprobe.rst b/Documentation/arch/riscv/hwprobe.rst
> > index 85b709257918..fb0affa61eb9 100644
> > --- a/Documentation/arch/riscv/hwprobe.rst
> > +++ b/Documentation/arch/riscv/hwprobe.rst
> > @@ -51,7 +51,7 @@ The following keys are defined:
> >  * :c:macro:`RISCV_HWPROBE_KEY_MARCHID`: Contains the value of ``marchid``, as
> >    defined by the RISC-V privileged architecture specification.
> >  
> > -* :c:macro:`RISCV_HWPROBE_KEY_MIMPLID`: Contains the value of ``mimplid``, as
> > +* :c:macro:`RISCV_HWPROBE_KEY_MIMPID`: Contains the value of ``mimpid``, as
> >    defined by the RISC-V privileged architecture specification.
> 
> You should be able to just say RISCV_HWPROBE_KEY_MIMPID() without the
> :c:macro: markup and have the right thing happen.

My .rst knowledge is limited, so I probably miss something obvious, but I
couldn't get that to work.

Do you mean something like below? The brackets do not seem to do anything
and get treated as plain text.

Sorry but you probably need to show me what to do exactly :(

Best regards,
Nam

diff --git a/Documentation/arch/riscv/hwprobe.rst b/Documentation/arch/riscv/hwprobe.rst
index 85b709257918..4b4b4ef0e0f9 100644
--- a/Documentation/arch/riscv/hwprobe.rst
+++ b/Documentation/arch/riscv/hwprobe.rst
@@ -51,7 +51,7 @@ The following keys are defined:
 * :c:macro:`RISCV_HWPROBE_KEY_MARCHID`: Contains the value of ``marchid``, as
   defined by the RISC-V privileged architecture specification.
 
-* :c:macro:`RISCV_HWPROBE_KEY_MIMPLID`: Contains the value of ``mimplid``, as
+* `RISCV_HWPROBE_KEY_MIMPID()`: Contains the value of ``mimpid``, as
   defined by the RISC-V privileged architecture specification.
 
 * :c:macro:`RISCV_HWPROBE_KEY_BASE_BEHAVIOR`: A bitmask containing the base