Skip to content

Commit 7a2ff00

Browse files
mchehabardbiesheuvel
authored andcommitted
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>
1 parent 96b0105 commit 7a2ff00

2 files changed

Lines changed: 9 additions & 4 deletions

File tree

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
.. SPDX-License-Identifier: GPL-2.0
22
3-
============
4-
UEFI Support
5-
============
3+
====================================================
4+
Unified Extensible Firmware Interface (UEFI) Support
5+
====================================================
66

77
UEFI stub library functions
88
===========================
99

1010
.. kernel-doc:: drivers/firmware/efi/libstub/mem.c
1111
:internal:
12+
13+
UEFI Common Platform Error Record (CPER) functions
14+
==================================================
15+
16+
.. kernel-doc:: drivers/firmware/efi/cper.c

drivers/firmware/efi/cper.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ const char *cper_severity_str(unsigned int severity)
7070
}
7171
EXPORT_SYMBOL_GPL(cper_severity_str);
7272

73-
/*
73+
/**
7474
* cper_print_bits - print strings for set bits
7575
* @pfx: prefix for each line, including log level and prefix string
7676
* @bits: bit mask

0 commit comments

Comments
 (0)