diff options
| author | Steve French <stfrench@microsoft.com> | 2020-12-12 12:08:58 -0600 |
|---|---|---|
| committer | Steve French <stfrench@microsoft.com> | 2020-12-14 09:16:23 -0600 |
| commit | 607dfc79c37a0eb1320485ae9336aba0fd8b7723 (patch) | |
| tree | f345beeb5bfee0591699de8104cc8ff4d83f6b60 /fs/cifs/file.c | |
| parent | 7d6535b720421d58886d5590ffc3617d359aa871 (diff) | |
| download | linux-stable-607dfc79c37a0eb1320485ae9336aba0fd8b7723.tar.gz linux-stable-607dfc79c37a0eb1320485ae9336aba0fd8b7723.tar.bz2 linux-stable-607dfc79c37a0eb1320485ae9336aba0fd8b7723.zip | |
cifs: remove various function description warnings
When compiling with W=1 I noticed various functions that
did not follow proper style in describing (in the comments)
the parameters passed in to the function. For example:
fs/cifs/inode.c:2236: warning: Function parameter or member 'mode' not described in 'cifs_wait_bit_killable'
I did not address the style warnings in two of the six files
(connect.c and misc.c) in order to reduce risk of merge
conflict with pending patches. We can update those later.
Signed-off-by: Steve French <stfrench@microsoft.com>
Diffstat (limited to 'fs/cifs/file.c')
| -rw-r--r-- | fs/cifs/file.c | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/fs/cifs/file.c b/fs/cifs/file.c index be46fab4c96d..29176a56229f 100644 --- a/fs/cifs/file.c +++ b/fs/cifs/file.c @@ -416,6 +416,8 @@ static void cifsFileInfo_put_work(struct work_struct *work) * cifsFileInfo_put - release a reference of file priv data * * Always potentially wait for oplock handler. See _cifsFileInfo_put(). + * + * @cifs_file: cifs/smb3 specific info (eg refcounts) for an open file */ void cifsFileInfo_put(struct cifsFileInfo *cifs_file) { @@ -431,8 +433,11 @@ void cifsFileInfo_put(struct cifsFileInfo *cifs_file) * * If @wait_for_oplock_handler is true and we are releasing the last * reference, wait for any running oplock break handler of the file - * and cancel any pending one. If calling this function from the - * oplock break handler, you need to pass false. + * and cancel any pending one. + * + * @cifs_file: cifs/smb3 specific info (eg refcounts) for an open file + * @wait_oplock_handler: must be false if called from oplock_break_handler + * @offload: not offloaded on close and oplock breaks * */ void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, |