[PATCH] Update documentation of vfs_tmpfile

[PATCH] Update documentation of vfs_tmpfile

[Hok Chun NG (Ben)]

On function vfs_tmpfile, documentation is updated according to function signature update.

Description for 'dentry' and 'open_flag' removed.
Description for 'parentpath' and 'file' added.

Signed-off-by: Ben Hok-Chun NG <me@benbenng.net>
---
 fs/namei.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/fs/namei.c b/fs/namei.c
index 309ae6fc8c99..21261163d6d3 100644
--- a/fs/namei.c
+++ b/fs/namei.c
@@ -3571,9 +3571,9 @@ static int do_open(struct nameidata *nd,
 /**
  * vfs_tmpfile - create tmpfile
  * @mnt_userns:	user namespace of the mount the inode was found from
- * @dentry:	pointer to dentry of the base directory
+ * @parentpath: path to the base directory
+ * @file:  	pointer to the file struct of the new tmpfile
  * @mode:	mode of the new tmpfile
- * @open_flag:	flags
  *
  * Create a temporary file.
  *
-- 
2.34.1

Re: [PATCH] Update documentation of vfs_tmpfile

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 563 bytes --]

On Tue, Feb 21, 2023 at 03:55:54AM +0000, Hok Chun NG (Ben) wrote:
> On function vfs_tmpfile, documentation is updated according to function signature update.
> 
> Description for 'dentry' and 'open_flag' removed.
> Description for 'parentpath' and 'file' added.

What commit did vfs_tmpfile() change its signature?

For the patch description, I'd like to write "Commit <commit> changes
function signature for vfs_tmpfile(). Catch the function documentation
up with the change."

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] Update documentation of vfs_tmpfile

[Hok Chun NG (Ben)]

Hi Bagas,

> On Feb 21, 2023, at 8:21 AM, Bagas Sanjaya <bagasdotme@gmail.com> wrote:
> 
> On Tue, Feb 21, 2023 at 03:55:54AM +0000, Hok Chun NG (Ben) wrote:
>> On function vfs_tmpfile, documentation is updated according to function signature update.
>> 
>> Description for 'dentry' and 'open_flag' removed.
>> Description for 'parentpath' and 'file' added.
> 
> What commit did vfs_tmpfile() change its signature?

Changes of the function signature is from 9751b338656f05a0ce918befd5118fcd970c71c6
vfs: move open right after ->tmpfile() by Miklos Szeredi mszeredi@redhat.com

> 
> For the patch description, I'd like to write "Commit <commit> changes
> function signature for vfs_tmpfile(). Catch the function documentation
> up with the change."

I agree. Thank you for the suggestion.

> 
> Thanks.
> 
> -- 
> An old man doll... just what I always wanted! - Clara

Best,
Ben

Re: [PATCH] Update documentation of vfs_tmpfile

[Bagas Sanjaya]

On 2/22/23 08:15, Hok Chun NG (Ben) wrote:
> Hi Bagas,
> 
>> On Feb 21, 2023, at 8:21 AM, Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>>
>> On Tue, Feb 21, 2023 at 03:55:54AM +0000, Hok Chun NG (Ben) wrote:
>>> On function vfs_tmpfile, documentation is updated according to function signature update.
>>>
>>> Description for 'dentry' and 'open_flag' removed.
>>> Description for 'parentpath' and 'file' added.
>>
>> What commit did vfs_tmpfile() change its signature?
> 
> Changes of the function signature is from 9751b338656f05a0ce918befd5118fcd970c71c6
> vfs: move open right after ->tmpfile() by Miklos Szeredi mszeredi@redhat.com
> 

Nice.

The preferred git pretty format when referring to existing commit is
"%h (\"%s\")". Make sure that you set core.abbrev to at least 12.
 
>>
>> For the patch description, I'd like to write "Commit <commit> changes
>> function signature for vfs_tmpfile(). Catch the function documentation
>> up with the change."
> 
> I agree. Thank you for the suggestion.
> 

OK, thanks!

-- 
An old man doll... just what I always wanted! - Clara