Subject: Re: [PATCH] mm/compaction: improve comment
To: Yaowei Bai <baiyaowei@cmss.chinamobile.com>, akpm@linux-foundation.org
References: <1448353427-4240-1-git-send-email-baiyaowei@cmss.chinamobile.com>
Cc: iamjoonsoo.kim@lge.com, riel@redhat.com, mina86@mina86.com,
        linux-mm@kvack.org, linux-kernel@vger.kernel.org
From: Vlastimil Babka <vbabka@suse.cz>
Message-ID: <565487B1.9090906@suse.cz>
Date: Tue, 24 Nov 2015 16:52:17 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101
 Thunderbird/38.3.0
MIME-Version: 1.0
In-Reply-To: <1448353427-4240-1-git-send-email-baiyaowei@cmss.chinamobile.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 1226
Lines: 41

On 11/24/2015 09:23 AM, Yaowei Bai wrote:
> Make comment more accurate.

Make changelog more descriptive? :)

> Signed-off-by: Yaowei Bai <baiyaowei@cmss.chinamobile.com>
> ---
>   mm/compaction.c | 4 +++-
>   1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/mm/compaction.c b/mm/compaction.c
> index de3e1e7..b3cf915 100644
> --- a/mm/compaction.c
> +++ b/mm/compaction.c
> @@ -1708,7 +1708,9 @@ static void compact_nodes(void)
>   /* The written value is actually unused, all memory is compacted */
>   int sysctl_compact_memory;
>
> -/* This is the entry point for compacting all nodes via /proc/sys/vm */
> +/* This is the entry point for compacting all nodes via
> + * /proc/sys/vm/compact_memory
> + */

Strictly speaking, multi-line comments should have a leading empty line, 
e.g.:

/*
  * This is the entry point ...


>   int sysctl_compaction_handler(struct ctl_table *table, int write,
>   			void __user *buffer, size_t *length, loff_t *ppos)
>   {
>

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/