Re: [PATCH] memory : adjust the ugly comment

[Randy Dunlap <rdunlap@xenotime.net>]

Andrew Morton wrote:
> On Fri, 25 Sep 2009 17:20:51 +0800 Huang Shijie <shijie8@gmail.com> wrote:
> 
>> The origin comment is too ugly, so modify it more beautiful.
>>
>> Signed-off-by: Huang Shijie <shijie8@gmail.com>
>> ---
>>  mm/memory.c |    5 ++++-
>>  1 files changed, 4 insertions(+), 1 deletions(-)
>>
>> diff --git a/mm/memory.c b/mm/memory.c
>> index 7e91b5f..6a38caa 100644
>> --- a/mm/memory.c
>> +++ b/mm/memory.c
>> @@ -2405,7 +2405,10 @@ restart:
>>  }
>>  
>>  /**
>> - * unmap_mapping_range - unmap the portion of all mmaps in the specified address_space corresponding to the specified page range in the underlying file.
>> + * unmap_mapping_range - unmap the portion of all mmaps in the specified
>> + *	 		address_space corresponding to the specified page range
>> + * 			in the underlying file.
>> + *
> 
> The comment must all be in a single line so that the kerneldoc tools
> process it correctly.  It's a kerneldoc restriction which all are
> welcome to fix ;)

Patch for that (multi-line "short" function descriptions)
was merged just a few days ago.

http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=commit;h=6423133bdee0e07d1c2f8411cb3fe676c207ba33


~Randy

--
To unsubscribe, send a message with 'unsubscribe linux-mm' in
the body to majordomo@kvack.org.  For more info on Linux MM,
see: http://www.linux-mm.org/ .
Don't email: <a href=mailto:"dont@kvack.org"> email@kvack.org </a>