2019-10-23 07:41:29

by Yi Wang

[permalink] [raw]
Subject: [PATCH] uprobes/x86: fix arch_uprobe_analyze_insn() comment

Fix parameter name in comment and adjust the order.
No functional change.

Signed-off-by: Yi Wang <[email protected]>
---
arch/x86/kernel/uprobes.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/kernel/uprobes.c b/arch/x86/kernel/uprobes.c
index 8cd745e..15e5aad 100644
--- a/arch/x86/kernel/uprobes.c
+++ b/arch/x86/kernel/uprobes.c
@@ -842,8 +842,8 @@ static int push_setup_xol_ops(struct arch_uprobe *auprobe, struct insn *insn)

/**
* arch_uprobe_analyze_insn - instruction analysis including validity and fixups.
+ * @auprobe: the probepoint information.
* @mm: the probed address space.
- * @arch_uprobe: the probepoint information.
* @addr: virtual address at which to install the probepoint
* Return 0 on success or a -ve number on error.
*/
--
1.8.3.1


2019-10-27 08:08:26

by tip-bot2 for Jacob Pan

[permalink] [raw]
Subject: [tip: x86/cleanups] x86/apic, x86/uprobes: Correct parameter names in kernel-doc comments

The following commit has been merged into the x86/cleanups branch of tip:

Commit-ID: 44eb5a7e5dc6f23d04c05c15f91bc279e0dc700d
Gitweb: https://git.kernel.org/tip/44eb5a7e5dc6f23d04c05c15f91bc279e0dc700d
Author: Yi Wang <[email protected]>
AuthorDate: Sun, 27 Oct 2019 08:55:39 +01:00
Committer: Borislav Petkov <[email protected]>
CommitterDate: Sun, 27 Oct 2019 09:00:28 +01:00

x86/apic, x86/uprobes: Correct parameter names in kernel-doc comments

Rename parameter names to the correct ones used in the function. No
functional changes.

[ bp: Merge two patches into a single one. ]

Signed-off-by: Yi Wang <[email protected]>
Signed-off-by: Borislav Petkov <[email protected]>
Cc: "H. Peter Anvin" <[email protected]>
Cc: Ingo Molnar <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Cc: x86-ml <[email protected]>
Link: https://lkml.kernel.org/r/[email protected]
---
arch/x86/kernel/apic/apic.c | 2 +-
arch/x86/kernel/uprobes.c | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/arch/x86/kernel/apic/apic.c b/arch/x86/kernel/apic/apic.c
index 9e2dd2b..8147106 100644
--- a/arch/x86/kernel/apic/apic.c
+++ b/arch/x86/kernel/apic/apic.c
@@ -2335,7 +2335,7 @@ static int cpuid_to_apicid[] = {
#ifdef CONFIG_SMP
/**
* apic_id_is_primary_thread - Check whether APIC ID belongs to a primary thread
- * @id: APIC ID to check
+ * @apicid: APIC ID to check
*/
bool apic_id_is_primary_thread(unsigned int apicid)
{
diff --git a/arch/x86/kernel/uprobes.c b/arch/x86/kernel/uprobes.c
index 8cd745e..15e5aad 100644
--- a/arch/x86/kernel/uprobes.c
+++ b/arch/x86/kernel/uprobes.c
@@ -842,8 +842,8 @@ static int push_setup_xol_ops(struct arch_uprobe *auprobe, struct insn *insn)

/**
* arch_uprobe_analyze_insn - instruction analysis including validity and fixups.
+ * @auprobe: the probepoint information.
* @mm: the probed address space.
- * @arch_uprobe: the probepoint information.
* @addr: virtual address at which to install the probepoint
* Return 0 on success or a -ve number on error.
*/