linux-kernel - [PATCH 7/8] Documentation: kvx: Use literal code block for command-line inputs

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:   Mon,  9 Jan 2023 16:51:07 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Jonathan Corbet <corbet@....net>,
        Yann Sionneau <ysionneau@...ray.eu>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Clement Leger <clement.leger@...tlin.com>,
        Guillaume Thouvenin <gthouvenin@...ray.eu>,
        Bagas Sanjaya <bagasdotme@...il.com>
Subject: [PATCH 7/8] Documentation: kvx: Use literal code block for command-line inputs

Command-line, like codes, looks ugly when default paragraph block is
used (since proportional font is used), where literal code blocks (which
render as monospace) do the job better.

Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 Documentation/kvx/kvx-iommu.rst |  2 +-
 Documentation/kvx/kvx.rst       | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/kvx/kvx-iommu.rst b/Documentation/kvx/kvx-iommu.rst
index 5e84dc12adb437..c95d9231d5b665 100644
--- a/Documentation/kvx/kvx-iommu.rst
+++ b/Documentation/kvx/kvx-iommu.rst
@@ -144,7 +144,7 @@ Maintenance interface
 It is possible to have several "maintainers" for the same IOMMU. The driver is
 using two of them. One that writes the TLB and another interface reads TLB. For
 debug purpose it is possible to display the content of the tlb by using the
-following command in gdb:
+following command in gdb::
 
     gdb> p kvx_iommu_dump_tlb( <iommu addr>, 0)
 
diff --git a/Documentation/kvx/kvx.rst b/Documentation/kvx/kvx.rst
index 4aac7fce4e3d01..5385e1e3d30187 100644
--- a/Documentation/kvx/kvx.rst
+++ b/Documentation/kvx/kvx.rst
@@ -122,7 +122,7 @@ To be able to set breakpoints when MMU is enabled we added a label called
 gdb_mmu_enabled. If you try to set a breakpoint on a function that is in
 virtual memory before the activation of the MMU this address as no signification
 for GDB. So, for example, if you want to break on the function start_kernel()
-you will need to run:
+you will need to run::
 
 	kvx-gdb -silent path_to/vmlinux \
 		-ex 'tbreak gdb_mmu_enabled' -ex 'run' \
@@ -253,19 +253,19 @@ Building
 ========
 
 In order to build the kernel, you will need a complete kvx toolchain.
-First, setup the config using the following command line
+First, setup the config using the following command line::
 
 $ make ARCH=kvx O=your_directory default_defconfig
 
-Adjust any configuration option you may need and then, build the kernel:
+Adjust any configuration option you may need and then, build the kernel::
 
 $ make ARCH=kvx O=your_directory -j12
 
-You will finally have a vmlinux image ready to be run.
+You will finally have a vmlinux image ready to be run::
 
 $ kvx-mppa -- vmlinux
 
-Additionally, you may want to debug it. To do so, use kvx-gdb:
+Additionally, you may want to debug it. To do so, use kvx-gdb::
 
 $ kvx-gdb vmlinux
 
-- 
An old man doll... just what I always wanted! - Clara