From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Ard Biesheuvel <mchehab+huawei@kernel.org>,
Jonathan Cameron <Jonathan.Cameron@huawei.com>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org, linux-efi@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH v3 5/5] docs: efi: add CPER functions to driver-api
Date: Mon, 5 Aug 2024 14:53:36 +0200 [thread overview]
Message-ID: <64dd3a377c4ebb1b8cfd2b406fe3f1c24cce0e4e.1722861911.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1722861911.git.mchehab+huawei@kernel.org>
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>
---
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
next prev parent reply other threads:[~2024-08-05 12:54 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-05 12:53 [PATCH v3 0/5] Fix issues with ARM Processor CPER records Mauro Carvalho Chehab
2024-08-05 12:53 ` [PATCH v3 1/5] RAS: Report all ARM processor CPER information to userspace Mauro Carvalho Chehab
2024-08-05 12:53 ` [PATCH v3 2/5] efi/cper: Adjust infopfx size to accept an extra space Mauro Carvalho Chehab
2024-08-05 12:53 ` [PATCH v3 3/5] efi/cper: Add a new helper function to print bitmasks Mauro Carvalho Chehab
2024-08-05 12:53 ` [PATCH v3 4/5] efi/cper: align ARM CPER type with UEFI 2.9A/2.10 specs Mauro Carvalho Chehab
2024-08-05 12:53 ` Mauro Carvalho Chehab [this message]
2024-09-04 6:07 [PATCH v3 0/5] Fix issues with ARM Processor CPER records Mauro Carvalho Chehab
2024-09-04 6:07 ` [PATCH v3 5/5] docs: efi: add CPER functions to driver-api Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=64dd3a377c4ebb1b8cfd2b406fe3f1c24cce0e4e.1722861911.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=Jonathan.Cameron@huawei.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-efi@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®