From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on gnuweeb.org X-Spam-Level: X-Spam-Status: No, score=-3.5 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by gnuweeb.org (Postfix) with ESMTPS id 46CEA7E24F for ; Mon, 11 Jul 2022 16:30:53 +0000 (UTC) Authentication-Results: gnuweeb.org; dkim=pass (2048-bit key; unprotected) header.d=intel.com header.i=@intel.com header.a=rsa-sha256 header.s=Intel header.b=EwbuepcD; dkim-atps=neutral DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1657557053; x=1689093053; h=date:from:to:cc:subject:message-id:references: mime-version:in-reply-to; bh=M7gQthUQ8v0LKr/DjxFP5tYXmCHQe3FMOrvQefnZBAQ=; b=EwbuepcDl2XHXFISdnqaio+IVJ2atIxBDI/TmPVda1m5ivMoI60kviVI Ivmj7WEjc77jHgBkgaE77DIQTZofi/JZd24OYRwce3RCd6Ys2EyiXsZC0 kpWmMSwfbKvGrAP478be/A/KwatlCF95oQ3pkcucdOYWTagruDTdSUaHL jJdJJW9k3AyUwVxnpcjJirT0crZjWJTTrOx2z0ypMfOZ1QcWtTYhZC5g0 d4pPMO3NnhgLz1HVDzR0LESEMXTnz3ltswaoQ2EHNkggdsdXL95KSX/pP TdSlCk03MXn80QGUUxjhRDsIdk5nyH9RaaaMxNEhhN5MBxgKGl/wHSwcj w==; X-IronPort-AV: E=McAfee;i="6400,9594,10405"; a="285836102" X-IronPort-AV: E=Sophos;i="5.92,263,1650956400"; d="scan'208";a="285836102" Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 11 Jul 2022 09:29:52 -0700 X-IronPort-AV: E=Sophos;i="5.92,263,1650956400"; d="scan'208";a="921846535" Received: from silpixa00400314.ir.intel.com (HELO silpixa00400314) ([10.237.222.76]) by fmsmga005-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 11 Jul 2022 09:29:49 -0700 Date: Mon, 11 Jul 2022 17:29:39 +0100 From: Giovanni Cabiddu To: lkp@intel.com, Vlad Dronov , Herbert Xu Cc: kbuild-all@lists.01.org, GNU/Weeb Mailing List , LKML , Tomasz Kowallik , Adam Guerin , Fiona Trahe , Wojciech Ziemba , linux-doc@vger.kernel.org, linux-crypto@vger.kernel.org Subject: Re: [PATCH RESEND] crypto: qat - fix indentation in ABI documentation Message-ID: References: <202207090803.TEGI95qw-lkp@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Organization: Intel Research and Development Ireland Ltd - Co. Reg. #308263 - Collinstown Industrial Park, Leixlip, County Kildare - Ireland List-Id: On Mon, Jul 11, 2022 at 05:05:18PM +0100, Giovanni Cabiddu wrote: > On Mon, Jul 11, 2022 at 02:35:07PM +0200, Vlad Dronov wrote: > > Hi, > > > > On Mon, Jul 11, 2022 at 11:32 AM Giovanni Cabiddu > > wrote: > > > > > > On Sat, Jul 09, 2022 at 08:23:35AM +0800, kernel test robot wrote: > > ...skip... > > > > >> Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation. > > > > > > > > vim +24 Documentation/ABI/testing/sysfs-driver-qat > > > > > > > > > 24 Date: June 2022 > > > I'm not able to spot what the issue is. Any suggestions? > > > > Same here. I do not see what issue the test robot is reporting. > I found what the issue is. It seems Sphinx doesn't like the extra > indentation in the sections. Resending including linux-crypto. Apologies for the duplicate. ----8<---- From: Giovanni Cabiddu Date: Mon, 11 Jul 2022 16:18:43 +0100 Subject: [PATCH] crypto: qat - fix indentation in ABI documentation Organization: Intel Research and Development Ireland Ltd - Co. Reg. #308263 - Collinstown Industrial Park, Leixlip, County Kildare - Ireland Change the indentation in the file sysfs-driver-qat to resolve the following warning when generating documentation with `make htmldocs`: Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation. Fixes: d4cfb144f605 ("crypto: qat - expose device config through sysfs for 4xxx") Reported-by: kernel test robot Signed-off-by: Giovanni Cabiddu --- Documentation/ABI/testing/sysfs-driver-qat | 38 ++++++++++------------ 1 file changed, 17 insertions(+), 21 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat index a600531e9562..741d97fa5ae1 100644 --- a/Documentation/ABI/testing/sysfs-driver-qat +++ b/Documentation/ABI/testing/sysfs-driver-qat @@ -8,12 +8,12 @@ Description: Reports the current state of the QAT device and allows to This attribute is RW. Returned values: - up: the device is up and running - down: the device is down + up: the device is up and running + down: the device is down Allowed values: - up: initialize and start the device - down: stop the device and bring it down + up: initialize and start the device + down: stop the device and bring it down It is possible to transition the device from up to down only if the device is up and vice versa. @@ -30,16 +30,12 @@ Description: Reports the current configuration of the QAT device and allows This attribute is RW. Returned values: - sym;asym: the device is configured for running - crypto services - dc: the device is configured for running - compression services + sym;asym: the device is configured for running crypto services + dc: the device is configured for running compression services Allowed values: - sym;asym: configure the device for running - crypto services - dc: configure the device for running - compression services + sym;asym: configure the device for running crypto services + dc: configure the device for running compression services It is possible to set the configuration only if the device is in the `down` state (see /sys/bus/pci/devices//qat/state) @@ -47,14 +43,14 @@ 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: - # cat /sys/bus/pci/devices//qat/state - up - # cat /sys/bus/pci/devices//qat/cfg_services - sym;asym - # echo down > /sys/bus/pci/devices//qat/state - # echo dc > /sys/bus/pci/devices//qat/cfg_services - # echo up > /sys/bus/pci/devices//qat/state - # cat /sys/bus/pci/devices//qat/cfg_services - dc + # cat /sys/bus/pci/devices//qat/state + up + # cat /sys/bus/pci/devices//qat/cfg_services + sym;asym + # echo down > /sys/bus/pci/devices//qat/state + # echo dc > /sys/bus/pci/devices//qat/cfg_services + # echo up > /sys/bus/pci/devices//qat/state + # cat /sys/bus/pci/devices//qat/cfg_services + dc This attribute is only available for qat_4xxx devices. -- 2.36.1