[PATCH] x86/alternative: Update the description for text_poke_bp

[PATCH] x86/alternative: Update the description for text_poke_bp

[Qiujun Huang]

The function changed at some point, but the description was not
updated.

Signed-off-by: Qiujun Huang <hqjagain@gmail.com>
---
 arch/x86/kernel/alternative.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/kernel/alternative.c b/arch/x86/kernel/alternative.c
index 2400ad62f330..8d778e46725d 100644
--- a/arch/x86/kernel/alternative.c
+++ b/arch/x86/kernel/alternative.c
@@ -1374,7 +1374,7 @@ void __ref text_poke_queue(void *addr, const void *opcode, size_t len, const voi
  * @addr:	address to patch
  * @opcode:	opcode of new instruction
  * @len:	length to copy
- * @handler:	address to jump to when the temporary breakpoint is hit
+ * @emulate:	instruction to be emulated
  *
  * Update a single instruction with the vector in the stack, avoiding
  * dynamically allocated memory. This function should be used when it is
-- 
2.17.1

[tip: x86/cleanups] x86/alternative: Update text_poke_bp() kernel-doc comment

[tip-bot2 for Qiujun Huang]

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

Commit-ID:     72ebb5ff806f9a421a2a53cdfe6c4ebbab243bd5
Gitweb:        https://git.kernel.org/tip/72ebb5ff806f9a421a2a53cdfe6c4ebbab243bd5
Author:        Qiujun Huang <hqjagain@gmail.com>
AuthorDate:    Thu, 03 Dec 2020 22:50:20 +08:00
Committer:     Borislav Petkov <bp@suse.de>
CommitterDate: Mon, 07 Dec 2020 12:44:22 +01:00

x86/alternative: Update text_poke_bp() kernel-doc comment

Update kernel-doc parameter name after

  c3d6324f841b ("x86/alternatives: Teach text_poke_bp() to emulate instructions")

changed the last parameter from @handler to @emulate.

 [ bp: Make commit message more precise. ]

Signed-off-by: Qiujun Huang <hqjagain@gmail.com>
Signed-off-by: Borislav Petkov <bp@suse.de>
Link: https://lkml.kernel.org/r/20201203145020.2441-1-hqjagain@gmail.com
---
 arch/x86/kernel/alternative.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/kernel/alternative.c b/arch/x86/kernel/alternative.c
index 4adbe65..ed3efc5 100644
--- a/arch/x86/kernel/alternative.c
+++ b/arch/x86/kernel/alternative.c
@@ -1365,7 +1365,7 @@ void __ref text_poke_queue(void *addr, const void *opcode, size_t len, const voi
  * @addr:	address to patch
  * @opcode:	opcode of new instruction
  * @len:	length to copy
- * @handler:	address to jump to when the temporary breakpoint is hit
+ * @emulate:	instruction to be emulated
  *
  * Update a single instruction with the vector in the stack, avoiding
  * dynamically allocated memory. This function should be used when it is