Gh0st
/
linux
mirror of https://github.com/torvalds/linux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: efi: add CPER functions to driver-api 

There are two kernel-doc like descriptions at cper, which is used
by other parts of cper and on ghes driver. They both have kernel-doc
like descriptions.

Change the tags for them to be actual kernel-doc tags and add them
to the driver-api documentaion at the UEFI section.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Acked-by: Borislav Petkov (AMD) <bp@alien8.de>
Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2025-08-14 09:52:56 -07:00 committed by Ard Biesheuvel
parent 96b010536e
commit 7a2ff00c3b
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/driver-api/firmware/efi/index.rst
View File

@ -1,11 +1,16 @@
.. SPDX-License-Identifier: GPL-2.0
============
UEFI Support
============
====================================================
Unified Extensible Firmware Interface (UEFI) Support
====================================================
UEFI stub library functions
===========================
.. kernel-doc:: drivers/firmware/efi/libstub/mem.c
:internal:
UEFI Common Platform Error Record (CPER) functions
==================================================
.. kernel-doc:: drivers/firmware/efi/cper.c

2
drivers/firmware/efi/cper.c
View File

@ -70,7 +70,7 @@ const char *cper_severity_str(unsigned int severity)
}
EXPORT_SYMBOL_GPL(cper_severity_str);
/*
/**
* cper_print_bits - print strings for set bits
* @pfx: prefix for each line, including log level and prefix string
* @bits: bit mask