diff mbox series

Documentation: RISC-V: hwprobe: Fix a formatting error

Message ID 20230710193329.2742-1-palmer@rivosinc.com
State New
Headers
Series Documentation: RISC-V: hwprobe: Fix a formatting error |

Commit Message

Palmer Dabbelt July 10, 2023, 7:33 p.m. UTC 
  From: Palmer Dabbelt <palmer@rivosinc.com>

I'm not sure what I was trying to do with the ':'s, but they're just
rendered to HTML which looks odd.   This makes "fence.i" look like
"mvendorid" and such, which is seems reasonable to me.

Signed-off-by: Palmer Dabbelt <palmer@rivosinc.com>
---
 Documentation/riscv/hwprobe.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Evan Green July 10, 2023, 7:40 p.m. UTC | #1 
On Mon, Jul 10, 2023 at 12:34 PM Palmer Dabbelt <palmer@rivosinc.com> wrote:
>
> From: Palmer Dabbelt <palmer@rivosinc.com>
>
> I'm not sure what I was trying to do with the ':'s, but they're just
> rendered to HTML which looks odd.   This makes "fence.i" look like
> "mvendorid" and such, which is seems reasonable to me.
>
> Signed-off-by: Palmer Dabbelt <palmer@rivosinc.com>

Ah whoops, I must have missed that one during the documentation cleanup. Thanks.

Reviewed-by: Evan Green <evan@rivosinc.com>
Palmer Dabbelt July 12, 2023, 1:39 p.m. UTC | #2 
On Mon, 10 Jul 2023 12:33:30 -0700, Palmer Dabbelt wrote:
> I'm not sure what I was trying to do with the ':'s, but they're just
> rendered to HTML which looks odd.   This makes "fence.i" look like
> "mvendorid" and such, which is seems reasonable to me.
> 
> 

Applied, thanks!

[1/1] Documentation: RISC-V: hwprobe: Fix a formatting error
      https://git.kernel.org/palmer/c/d6e724d3ef0b

Best regards,
patchwork-bot+linux-riscv@kernel.org July 12, 2023, 1:50 p.m. UTC | #3 
Hello:

This patch was applied to riscv/linux.git (fixes)
by Palmer Dabbelt <palmer@rivosinc.com>:

On Mon, 10 Jul 2023 12:33:30 -0700 you wrote:
> From: Palmer Dabbelt <palmer@rivosinc.com>
> 
> I'm not sure what I was trying to do with the ':'s, but they're just
> rendered to HTML which looks odd.   This makes "fence.i" look like
> "mvendorid" and such, which is seems reasonable to me.
> 
> Signed-off-by: Palmer Dabbelt <palmer@rivosinc.com>
> 
> [...]

Here is the summary with links:
  - Documentation: RISC-V: hwprobe: Fix a formatting error
    https://git.kernel.org/riscv/c/d6e724d3ef0b

You are awesome, thank you!
diff mbox series

Patch

diff --git a/Documentation/riscv/hwprobe.rst b/Documentation/riscv/hwprobe.rst
index 19165ebd82ba..933c715065d6 100644
--- a/Documentation/riscv/hwprobe.rst
+++ b/Documentation/riscv/hwprobe.rst
@@ -49,7 +49,7 @@  The following keys are defined:
     privileged ISA, with the following known exceptions (more exceptions may be
     added, but only if it can be demonstrated that the user ABI is not broken):
 
-    * The :fence.i: instruction cannot be directly executed by userspace
+    * The ``fence.i`` instruction cannot be directly executed by userspace
       programs (it may still be executed in userspace via a
       kernel-controlled mechanism such as the vDSO).