2020-09-18 07:51:58

by Xiaofei Tan

[permalink] [raw]
Subject: [PATCH] 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'

Signed-off-by: Xiaofei Tan <[email protected]>
---
drivers/tty/vt/vt.c | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/drivers/tty/vt/vt.c b/drivers/tty/vt/vt.c
index 19cd4a4..1e9a6b6 100644
--- a/drivers/tty/vt/vt.c
+++ b/drivers/tty/vt/vt.c
@@ -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.
--
2.8.1


2020-09-18 08:17:26

by Jiri Slaby

[permalink] [raw]
Subject: Re: [PATCH] vt: fix some doc warnings in vt.c

On 18. 09. 20, 9:47, Xiaofei Tan wrote:
> 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,
--
js
suse labs

2020-09-19 02:31:13

by Xiaofei Tan

[permalink] [raw]
Subject: Re: [PATCH] vt: fix some doc warnings in vt.c

Hi Jiri,

On 2020/9/18 15:52, Jiri Slaby wrote:
> On 18. 09. 20, 9:47, Xiaofei Tan wrote:
>> 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.


> thanks,
>

--
thanks
tanxiaofei