platform/x86/intel/ifs: Fix SBAF title underline length

[PATCH v1] platform/x86/intel/ifs: Fix SBAF title underline length

Posted by Kuppuswamy Sathyanarayanan 1 year, 5 months ago

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

Re: [PATCH v1] platform/x86/intel/ifs: Fix SBAF title underline length

Posted by Hans de Goede 1 year, 5 months ago

Hi,

On 8/23/24 8:43 PM, Kuppuswamy Sathyanarayanan wrote:
> 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>

Thank you for your patch, I've applied this patch to my review-hans 
branch:
https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans

Note it will show up in my review-hans branch once I've pushed my
local branch there, which might take a while.

Once I've run some tests on this branch the patches there will be
added to the platform-drivers-x86/for-next branch and eventually
will be included in the pdx86 pull-request to Linus for the next
merge-window.

Regards,

Hans



> ---
>  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

Re: [PATCH v1] platform/x86/intel/ifs: Fix SBAF title underline length

Posted by Joseph, Jithu 1 year, 5 months ago


On 8/23/2024 11:43 AM, Kuppuswamy Sathyanarayanan wrote:
> 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>
> ---

Looks good to me
Reviewed-by: Jithu Joseph <jithu.joseph@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