[tip: x86/cleanups] x86/mtrr: Fix kernel-doc notation of amd_set_mtrr()
From: tip-bot2 for Manuel Ebner
Date: Wed Sep 16 2026 - 00:28:03 EST
The following commit has been merged into the x86/cleanups branch of tip:
Commit-ID: c8beda268a6b21910d1325584ce1d45bce4f22f0
Gitweb: https://git.kernel.org/tip/c8beda268a6b21910d1325584ce1d45bce4f22f0
Author: Manuel Ebner <manuelebnerli@xxxxxxxxxxx>
AuthorDate: Tue, 15 Sep 2026 12:31:37 +02:00
Committer: Borislav Petkov (AMD) <bp@xxxxxxxxx>
CommitterDate: Tue, 15 Sep 2026 21:22:03 -07:00
x86/mtrr: Fix kernel-doc notation of amd_set_mtrr()
Add ':' to arguments in kernel-doc comment to fix:
$ ./scripts/kernel-doc -none arch/x86/kernel/cpu/mtrr/amd.c
Warning: arch/x86/kernel/cpu/mtrr/amd.c:63 function parameter 'reg' not described in 'amd_set_mtrr'
Warning: arch/x86/kernel/cpu/mtrr/amd.c:63 function parameter 'base' not described in 'amd_set_mtrr'
Warning: arch/x86/kernel/cpu/mtrr/amd.c:63 function parameter 'size' not described in 'amd_set_mtrr'
Warning: arch/x86/kernel/cpu/mtrr/amd.c:63 function parameter 'type' not described in 'amd_set_mtrr'
[ bp: Massage commit message. ]
Signed-off-by: Manuel Ebner <manuelebnerli@xxxxxxxxxxx>
Signed-off-by: Borislav Petkov (AMD) <bp@xxxxxxxxx>
Link: https://patch.msgid.link/20260915103136.171924-3-manuelebnerli@xxxxxxxxxxx
---
arch/x86/kernel/cpu/mtrr/amd.c | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/arch/x86/kernel/cpu/mtrr/amd.c b/arch/x86/kernel/cpu/mtrr/amd.c
index a73715d..9e440e3 100644
--- a/arch/x86/kernel/cpu/mtrr/amd.c
+++ b/arch/x86/kernel/cpu/mtrr/amd.c
@@ -51,11 +51,10 @@ amd_get_mtrr(unsigned int reg, unsigned long *base,
/**
* amd_set_mtrr - Set variable MTRR register on the local CPU.
- *
- * @reg The register to set.
- * @base The base address of the region.
- * @size The size of the region. If this is 0 the region is disabled.
- * @type The type of the region.
+ * @reg: The register to set.
+ * @base: The base address of the region.
+ * @size: The size of the region. If this is 0 the region is disabled.
+ * @type: The type of the region.
*
* Returns nothing.
*/