[<prev] [next>] [day] [month] [year] [list]
Message-ID: <c6b1b295960779c25f235ac76263c5333f0b5888.1720679234.git.mchehab+huawei@kernel.org>
Date: Thu, 11 Jul 2024 08:28:56 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Borislav Petkov <bp@...en8.de>,
Tony Luck <tony.luck@...el.com>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
"Ard Biesheuvel" <ardb@...nel.org>,
"James Morse" <james.morse@....com>,
"Jonathan Cameron" <Jonathan.Cameron@...wei.com>,
"Len Brown" <lenb@...nel.org>,
"Rafael J. Wysocki" <rafael@...nel.org>,
"Shiju Jose" <shiju.jose@...wei.com>,
Jonathan Corbet <corbet@....net>,
linux-acpi@...r.kernel.org,
linux-doc@...r.kernel.org,
linux-edac@...r.kernel.org,
linux-efi@...r.kernel.org,
linux-kernel@...r.kernel.org
Subject: [PATCH v2 5/5] 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@...nel.org>
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@...wei.com>
---
Documentation/driver-api/firmware/efi/index.rst | 11 ++++++++---
drivers/firmware/efi/cper.c | 2 +-
2 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/Documentation/driver-api/firmware/efi/index.rst b/Documentation/driver-api/firmware/efi/index.rst
index 4fe8abba9fc6..5a6b6229592c 100644
--- a/Documentation/driver-api/firmware/efi/index.rst
+++ b/Documentation/driver-api/firmware/efi/index.rst
@@ -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
diff --git a/drivers/firmware/efi/cper.c b/drivers/firmware/efi/cper.c
index 462d739e8dd1..295f6f339575 100644
--- a/drivers/firmware/efi/cper.c
+++ b/drivers/firmware/efi/cper.c
@@ -69,7 +69,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
--
2.45.2
Powered by blists - more mailing lists