Re: linux-next: build warning after merge of the drivers-x86 tree

[Kuppuswamy Sathyanarayanan <sathyanarayanan.kuppuswamy@linux.intel.com>]

[-- Attachment #1: Type: text/plain, Size: 682 bytes --]

Hi Hans,

On 8/19/24 8:43 PM, Stephen Rothwell wrote:
> Hi all,
>
> After merging the drivers-x86 tree, today's linux-next build (htmldocs)
> produced this warning:
>
> Documentation/arch/x86/ifs:2: /home/sfr/next/next/drivers/platform/x86/intel/ifs/ifs.h:131: WARNING: Title underline too short.
>
> Structural Based Functional Test at Field (SBAF):
> ------------------------------------------------
>
> Introduced by commit
>
>   0a3e4e94d137 ("platform/x86/intel/ifs: Add SBAF test image loading support")

Attached patch fixes the issue. Do you want to me send it to the mailing list or
you can take the attached patch?

>
-- 
Sathyanarayanan Kuppuswamy
Linux Kernel Developer

[-- Attachment #2: 0001-platform-x86-intel-ifs-Fix-SBAF-title-underline-leng.patch --]
[-- Type: text/x-patch, Size: 1652 bytes --]

From 76f6a43eeafd892dde53b9fb3c67aad90eff81a6 Mon Sep 17 00:00:00 2001
From: Kuppuswamy Sathyanarayanan <sathyanarayanan.kuppuswamy@linux.intel.com>
Date: Tue, 20 Aug 2024 04:02:55 +0000
Subject: [PATCH v1] platform/x86/intel/ifs: Fix SBAF title underline length

In commit # 0a3e4e94d137 ("platform/x86/intel/ifs: Add SBAF test image
loading support"), the documentation for "Structural Based Functional
Test at Field (SBAF)" had an incomplete underline. This resulted in the
following build warning:

Documentation/arch/x86/ifs:2: drivers/platform/x86/intel/ifs/ifs.h:131: WARNING: Title underline too short.

Fix it by extending the dotted lines to match the length of the title.

Fixes: 0a3e4e94d137 ("platform/x86/intel/ifs: Add SBAF test image loading support")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/lkml/20240820134354.2aec355d@canb.auug.org.au/T/#u
Signed-off-by: Kuppuswamy Sathyanarayanan <sathyanarayanan.kuppuswamy@linux.intel.com>
---
 drivers/platform/x86/intel/ifs/ifs.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/platform/x86/intel/ifs/ifs.h b/drivers/platform/x86/intel/ifs/ifs.h
index b261be46bce8..5c3c0dfa1bf8 100644
--- a/drivers/platform/x86/intel/ifs/ifs.h
+++ b/drivers/platform/x86/intel/ifs/ifs.h
@@ -129,7 +129,7 @@
  *
  *
  * Structural Based Functional Test at Field (SBAF):
- * ------------------------------------------------
+ * -------------------------------------------------
  *
  * SBAF is a new type of testing that provides comprehensive core test
  * coverage complementing Scan at Field (SAF) testing. SBAF mimics the
-- 
2.25.1