lkml.org 
[lkml]   [2013]   [Feb]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] mm: accurately document nr_free_*_pages functions with code comments
On 02/06/13 00:25, Zhang Yanfei wrote:
> Functions nr_free_zone_pages, nr_free_buffer_pages and nr_free_pagecache_pages
> are horribly badly named, so accurately document them with code comments
> in case of the misuse of them.
>
> Signed-off-by: Zhang Yanfei <zhangyanfei@cn.fujitsu.com>
> ---
> mm/page_alloc.c | 23 +++++++++++++++++++----
> 1 files changed, 19 insertions(+), 4 deletions(-)
>
> diff --git a/mm/page_alloc.c b/mm/page_alloc.c
> index df2022f..0790716 100644
> --- a/mm/page_alloc.c
> +++ b/mm/page_alloc.c
> @@ -2785,6 +2785,15 @@ void free_pages_exact(void *virt, size_t size)
> }
> EXPORT_SYMBOL(free_pages_exact);
>
> +/**
> + * nr_free_zone_pages - get pages that is beyond high watermark
> + * @offset - The zone index of the highest zone

Function parameter format uses a ':', not a '-'. E.g.,

* @offset: the zone index of the highest zone


> + *
> + * The function counts pages which are beyond high watermark within
> + * all zones at or below a given zone index. For each zone, the
> + * amount of pages is calculated as:
> + * present_pages - high_pages
> + */
> static unsigned int nr_free_zone_pages(int offset)
> {
> struct zoneref *z;
> @@ -2805,8 +2814,11 @@ static unsigned int nr_free_zone_pages(int offset)
> return sum;
> }
>
> -/*
> - * Amount of free RAM allocatable within ZONE_DMA and ZONE_NORMAL
> +/**
> + * nr_free_buffer_pages - get pages that is beyond high watermark
> + *
> + * The function counts pages which are beyond high watermark within
> + * ZONE_DMA and ZONE_NORMAL.
> */
> unsigned int nr_free_buffer_pages(void)
> {
> @@ -2814,8 +2826,11 @@ unsigned int nr_free_buffer_pages(void)
> }
> EXPORT_SYMBOL_GPL(nr_free_buffer_pages);
>
> -/*
> - * Amount of free RAM allocatable within all zones
> +/**
> + * nr_free_pagecache_pages - get pages that is beyond high watermark
> + *
> + * The function counts pages which are beyond high watermark within
> + * all zones.
> */
> unsigned int nr_free_pagecache_pages(void)
> {
>


--
~Randy


\
 
 \ /
  Last update: 2013-02-07 02:41    [W:3.170 / U:0.004 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site