From mboxrd@z Thu Jan 1 00:00:00 1970 From: Krzysztof Kozlowski Subject: Re: [PATCH 2/3] i2c: s3c2410: Minor function-level comment cleanup Date: Thu, 21 Apr 2016 09:01:20 +0200 Message-ID: <57187AC0.3000503@samsung.com> References: <1461144292-22141-1-git-send-email-k.kozlowski@samsung.com> <1461144292-22141-2-git-send-email-k.kozlowski@samsung.com> <57178B58.7050104@osg.samsung.com> Mime-Version: 1.0 Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit Return-path: Received: from mailout1.w1.samsung.com ([210.118.77.11]:34739 "EHLO mailout1.w1.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751722AbcDUHB0 (ORCPT ); Thu, 21 Apr 2016 03:01:26 -0400 In-reply-to: <57178B58.7050104@osg.samsung.com> Sender: linux-i2c-owner@vger.kernel.org List-Id: linux-i2c@vger.kernel.org To: Javier Martinez Canillas , Kukjin Kim , Wolfram Sang , linux-arm-kernel@lists.infradead.org, linux-samsung-soc@vger.kernel.org, linux-i2c@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Bartlomiej Zolnierkiewicz On 04/20/2016 03:59 PM, Javier Martinez Canillas wrote: > Hello Krzysztof, > > On 04/20/2016 05:24 AM, Krzysztof Kozlowski wrote: >> Cleanup the weird function-level comments and remove obvious >> documentatoin for probe/remove. >> > > s/documentatoin/documentation > >> Signed-off-by: Krzysztof Kozlowski >> --- > > I wonder if instead we should change to kernel-doc formatted documentation. > > All the functions are static so kernel-doc is not really required but still > Documentation/kernel-doc-nano-HOWTO.txt says that is suggested for source > code layout consistency. > > But I agree that's either kernel-doc format or minimal as your patch does: > > Reviewed-by: Javier Martinez Canillas Thanks for review. Indeed switching to kernel-doc would be the best... but that would require a little bit more rewritting than now. I just wanted to fix some weird looking comments. Best regards, Krzysztof From mboxrd@z Thu Jan 1 00:00:00 1970 From: k.kozlowski@samsung.com (Krzysztof Kozlowski) Date: Thu, 21 Apr 2016 09:01:20 +0200 Subject: [PATCH 2/3] i2c: s3c2410: Minor function-level comment cleanup In-Reply-To: <57178B58.7050104@osg.samsung.com> References: <1461144292-22141-1-git-send-email-k.kozlowski@samsung.com> <1461144292-22141-2-git-send-email-k.kozlowski@samsung.com> <57178B58.7050104@osg.samsung.com> Message-ID: <57187AC0.3000503@samsung.com> To: linux-arm-kernel@lists.infradead.org List-Id: linux-arm-kernel.lists.infradead.org On 04/20/2016 03:59 PM, Javier Martinez Canillas wrote: > Hello Krzysztof, > > On 04/20/2016 05:24 AM, Krzysztof Kozlowski wrote: >> Cleanup the weird function-level comments and remove obvious >> documentatoin for probe/remove. >> > > s/documentatoin/documentation > >> Signed-off-by: Krzysztof Kozlowski >> --- > > I wonder if instead we should change to kernel-doc formatted documentation. > > All the functions are static so kernel-doc is not really required but still > Documentation/kernel-doc-nano-HOWTO.txt says that is suggested for source > code layout consistency. > > But I agree that's either kernel-doc format or minimal as your patch does: > > Reviewed-by: Javier Martinez Canillas Thanks for review. Indeed switching to kernel-doc would be the best... but that would require a little bit more rewritting than now. I just wanted to fix some weird looking comments. Best regards, Krzysztof