linux-kernel - [PATCH next 1/3] Documentation: qat: Use code block for qat sysfs example

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: <20220712092954.142027-2-bagasdotme@gmail.com>
Date:   Tue, 12 Jul 2022 16:29:52 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     linux-doc@...r.kernel.org
Cc:     Bagas Sanjaya <bagasdotme@...il.com>,
        kernel test robot <lkp@...el.com>,
        Stephen Rothwell <sfr@...b.auug.org.au>,
        Wojciech Ziemba <wojciech.ziemba@...el.com>,
        Adam Guerin <adam.guerin@...el.com>,
        Fiona Trahe <fiona.trahe@...el.com>,
        Giovanni Cabiddu <giovanni.cabiddu@...el.com>,
        Herbert Xu <herbert@...dor.apana.org.au>,
        Vladis Dronov <vdronov@...hat.com>,
        Tomasz Kowallik <tomaszx.kowalik@...el.com>,
        linux-crypto@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: [PATCH next 1/3] Documentation: qat: Use code block for qat sysfs example

kernel test robot and Stephen Rothwell reported htmldocs warning:

Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation.

The warning isn't caused by Date: field pointed by the warning, but rather
by sysfs example that isn't in literal code block.

Add the code block marker.

Link: https://lore.kernel.org/linux-next/20220711204932.333379b4@canb.auug.org.au/
Link: https://lore.kernel.org/linux-doc/202207090803.TEGI95qw-lkp@intel.com/
Reported-by: kernel test robot <lkp@...el.com>
Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
Fixes: d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")
Cc: Wojciech Ziemba <wojciech.ziemba@...el.com>
Cc: Adam Guerin <adam.guerin@...el.com>
Cc: Fiona Trahe <fiona.trahe@...el.com>
Cc: Giovanni Cabiddu <giovanni.cabiddu@...el.com>
Cc: Herbert Xu <herbert@...dor.apana.org.au>
Cc: Vladis Dronov <vdronov@...hat.com>
Cc: Tomasz Kowallik <tomaszx.kowalik@...el.com>
Cc: linux-crypto@...r.kernel.org
Cc: linux-kernel@...r.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 Documentation/ABI/testing/sysfs-driver-qat | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat
index a600531e95628f..43e081ec22cc4a 100644
--- a/Documentation/ABI/testing/sysfs-driver-qat
+++ b/Documentation/ABI/testing/sysfs-driver-qat
@@ -46,7 +46,8 @@ Description:	Reports the current configuration of the QAT device and allows
 
 		The following example shows how to change the configuration of
 		a device configured for running crypto services in order to
-		run data compression:
+		run data compression::
+
 			# cat /sys/bus/pci/devices/<BDF>/qat/state
 			up
 			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
-- 
An old man doll... just what I always wanted! - Clara