linux-kernel - [PATCH 2/2] Documentation: bpf: Use sphinx-prompt

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: <20230824182107.3702766-3-nm@ti.com>
Date:   Thu, 24 Aug 2023 13:21:07 -0500
From:   Nishanth Menon <nm@...com>
To:     Mauro Carvalho Chehab <mchehab@...nel.org>,
        Jonathan Corbet <corbet@....net>
CC:     <linux-kernel@...r.kernel.org>, <linux-doc@...r.kernel.org>,
        <bpf@...r.kernel.org>,
        Heinrich Schuchardt <heinrich.schuchardt@...onical.com>,
        Mattijs Korpershoek <mkorpershoek@...libre.com>,
        Simon Glass <sjg@...omium.org>, Tom Rini <trini@...sulko.com>,
        Neha Francis <n-francis@...com>, Nishanth Menon <nm@...com>
Subject: [PATCH 2/2] Documentation: bpf: Use sphinx-prompt

Use Sphinx-prompt to generate a better rendered documentation that is
easier for copy-paste.

Signed-off-by: Nishanth Menon <nm@...com>
---
 Documentation/bpf/libbpf/libbpf_build.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Documentation/bpf/libbpf/libbpf_build.rst b/Documentation/bpf/libbpf/libbpf_build.rst
index 8e8c23e8093d..2b94e5778702 100644
--- a/Documentation/bpf/libbpf/libbpf_build.rst
+++ b/Documentation/bpf/libbpf/libbpf_build.rst
@@ -13,25 +13,25 @@ setting NO_PKG_CONFIG=1 when calling make.
 
 To build both static libbpf.a and shared libbpf.so:
 
-.. code-block:: bash
+.. prompt:: bash $
 
-    $ cd src
-    $ make
+    cd src
+    make
 
 To build only static libbpf.a library in directory build/ and install them
 together with libbpf headers in a staging directory root/:
 
-.. code-block:: bash
+.. prompt:: bash $
 
-    $ cd src
-    $ mkdir build root
-    $ BUILD_STATIC_ONLY=y OBJDIR=build DESTDIR=root make install
+    cd src
+    mkdir build root
+    BUILD_STATIC_ONLY=y OBJDIR=build DESTDIR=root make install
 
 To build both static libbpf.a and shared libbpf.so against a custom libelf
 dependency installed in /build/root/ and install them together with libbpf
 headers in a build directory /build/root/:
 
-.. code-block:: bash
+.. prompt:: bash $
 
-    $ cd src
-    $ PKG_CONFIG_PATH=/build/root/lib64/pkgconfig DESTDIR=/build/root make
\ No newline at end of file
+    cd src
+    PKG_CONFIG_PATH=/build/root/lib64/pkgconfig DESTDIR=/build/root make
-- 
2.40.0