Skip to contentSkip to conversation

vt: fix some doc warnings in vt.c

PATCH In review Xiaofei Tan 2 participants 3 messages Sep 18, 2020 – Sep 19, 2020 TTY layer and serial drivers

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 vt: fix some doc warnings in vt.c

Fix following warnings caused by mismatch bewteen function parameters
and comments.
drivers/tty/vt/vt.c:3994: warning: Function parameter or member 'vc' not described in 'con_debug_enter' drivers/tty/vt/vt.c:3994: warning: Excess function parameter 'sw' description in 'con_debug_enter' drivers/tty/vt/vt.c:4051: warning: Excess function parameter 'sw' description in 'con_debug_leave'

---
 drivers/tty/vt/vt.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)
drivers/tty/vt/vt.c +1 -3
index 19cd4a4..1e9a6b6 100644
@@ -1180,7 +1180,6 @@ static inline int resize_screen(struct vc_data *vc, int width, int height,
 /**
  *	vc_do_resize	-	resizing method for the tty
  *	@tty: tty being resized
- *	@real_tty: real tty (different to tty if a pty/tty pair)
  *	@vc: virtual console private data
  *	@cols: columns
  *	@lines: lines
@@ -3980,7 +3979,7 @@ EXPORT_SYMBOL(con_is_visible);
 
 /**
  * con_debug_enter - prepare the console for the kernel debugger
- * @sw: console driver
+ * @vc: virtual console
  *
  * Called when the console is taken over by the kernel debugger, this
  * function needs to save the current console state, then put the console
@@ -4038,7 +4037,6 @@ EXPORT_SYMBOL_GPL(con_debug_enter);
 
 /**
  * con_debug_leave - restore console state
- * @sw: console driver
  *
  * Restore the console state to what it was before the kernel debugger
  * was invoked.
Signature · 1 line
2.8.1
maintainer
#1 lore raw
Quoted 5 lines · Xiaofei Tan

Fix following warnings caused by mismatch bewteen function parameters
and comments.
drivers/tty/vt/vt.c:3994: warning: Function parameter or member 'vc' not described in 'con_debug_enter' drivers/tty/vt/vt.c:3994: warning: Excess function parameter 'sw' description in 'con_debug_enter' drivers/tty/vt/vt.c:4051: warning: Excess function parameter 'sw' description in 'con_debug_leave'

It looks like I fixed those in
https://lore.kernel.org/r/[email protected]
too. Could you rebase on the top of tty-next?

thanks,

Signature · 2 lines
js
suse labs
#2 lore raw

Hi Jiri,

Quoted 11 lines · Jiri Slaby
Quoted 5 lines · Xiaofei Tan

Fix following warnings caused by mismatch bewteen function parameters
and comments.
drivers/tty/vt/vt.c:3994: warning: Function parameter or member 'vc' not described in 'con_debug_enter' drivers/tty/vt/vt.c:3994: warning: Excess function parameter 'sw' description in 'con_debug_enter' drivers/tty/vt/vt.c:4051: warning: Excess function parameter 'sw' description in 'con_debug_leave'

It looks like I fixed those in
https://lore.kernel.org/r/[email protected]
too. Could you rebase on the top of tty-next?

Oh, yes, I used a different branch.
Thanks for your remind.

Quoted 2 lines

thanks,

Signature · 2 lines
 thanks
tanxiaofei