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

From: Nam Cao <namcao@linutronix.de>
To: Jonathan Corbet <corbet@lwn.net>
Cc: "Paul Walmsley" <paul.walmsley@sifive.com>,
	"Palmer Dabbelt" <palmer@dabbelt.com>,
	"Albert Ou" <aou@eecs.berkeley.edu>,
	"Clément Léger" <cleger@rivosinc.com>,
	"Evan Green" <evan@rivosinc.com>,
	"Charlie Jenkins" <charlie@rivosinc.com>,
	"Andrew Jones" <ajones@ventanamicro.com>,
	linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation: riscv: Fix typo MIMPLID -> MIMPID
Date: Mon, 30 Sep 2024 20:49:15 +0200	[thread overview]
Message-ID: <20240930184915.vFs7xT1l@linutronix.de> (raw)
In-Reply-To: <87ldzab8np.fsf@trenco.lwn.net>

On Sun, Sep 29, 2024 at 12:46:02PM -0600, Jonathan Corbet wrote:
> Nam Cao <namcao@linutronix.de> writes:
> 
> > On Wed, Sep 25, 2024 at 12:02:39PM -0600, Jonathan Corbet wrote:
> >> Nam Cao <namcao@linutronix.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@linutronix.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.
> 
> It's not RST as such, it's an extension that we've added for th ekernel
> build. 
> 
> > 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.
> 
> Try it without the `backquotes`.

Also doesn't work :(

I digged around a bit, and I think for the thing you mentioned to work,
parse_headers.pl needs to be use on the header file (hwprobe.h in this
case), right? And only Documentation/userspace-api/media/ supports that
script at the moment.

Best regards,
Nam

_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv