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

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

[Nam Cao]

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.
 
 * :c:macro:`RISCV_HWPROBE_KEY_BASE_BEHAVIOR`: A bitmask containing the base
-- 
2.39.2


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

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

[Evan Green]

On Wed, Sep 25, 2024 at 7:26 AM Nam Cao <namcao@linutronix.de> wrote:
>
> 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>

Reviewed-by: Evan Green <evan@rivosinc.com>

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

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

[Conor Dooley]

[-- Attachment #1.1: Type: text/plain, Size: 1556 bytes --]

On Wed, Sep 25, 2024 at 04:25:32PM +0200, Nam Cao wrote:
> The macro that is really defined is RISCV_HWPROBE_KEY_MIMPID, not
> RISCV_HWPROBE_KEY_MIMPLID (difference is the 'L').

Heh, it is indeed.
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

> 
> 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..

Gowan, hit us with it...


> 
>  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.
>  
>  * :c:macro:`RISCV_HWPROBE_KEY_BASE_BEHAVIOR`: A bitmask containing the base
> -- 
> 2.39.2
> 
> 
> _______________________________________________
> linux-riscv mailing list
> linux-riscv@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-riscv

[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

[-- Attachment #2: Type: text/plain, Size: 161 bytes --]

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

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

[Andrew Jones]

On Wed, Sep 25, 2024 at 04:25:32PM GMT, Nam Cao wrote:
> 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..

Hopefully due to someone using the document as a reference when attempting
to use hwprobe.

> 
>  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.
>  
>  * :c:macro:`RISCV_HWPROBE_KEY_BASE_BEHAVIOR`: A bitmask containing the base
> -- 
> 2.39.2
>

Reviewed-by: Andrew Jones <ajones@ventanamicro.com>

Thanks,
drew

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

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

[Jonathan Corbet]

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.

Thanks,

jon

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

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

[Nam Cao]

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.

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

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

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

[Jonathan Corbet]

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`.

Thanks,

jon

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

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

[Nam Cao]

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

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

[Alexandre Ghiti]

Hi Nam, Jon,

On 25/09/2024 16:25, Nam Cao wrote:
> 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.
>   
>   * :c:macro:`RISCV_HWPROBE_KEY_BASE_BEHAVIOR`: A bitmask containing the base


It looks like this patch was never merged even though it is relevant. 
@Jon: is it ok to merge it as-is? If you want, I can merge it, let me 
know how you want to proceed.

Thanks,

Alex


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