From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933265AbdC3K4t (ORCPT ); Thu, 30 Mar 2017 06:56:49 -0400 Received: from mailout4.samsung.com ([203.254.224.34]:46495 "EHLO mailout4.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932558AbdC3K4r (ORCPT ); Thu, 30 Mar 2017 06:56:47 -0400 MIME-version: 1.0 Content-type: text/plain; charset=utf-8 X-AuditID: b6c32a2c-f79be6d0000051f7-16-58dce46d7cbf Content-transfer-encoding: 8BIT Message-id: <58DCE46C.3060501@samsung.com> Date: Thu, 30 Mar 2017 19:56:44 +0900 From: Chanwoo Choi Organization: Samsung Electronics User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.6.0 To: Andy Shevchenko Cc: "linux-kernel@vger.kernel.org" , Hans de Goede , chanwoo@kernel.org, MyungJoo Ham Subject: Re: [PATCH 2/2] extcon: Add new extcon_register_notifier_all() to monitor all external connectors In-reply-to: X-Brightmail-Tracker: H4sIAAAAAAAAA02SbUhTYRTHeXa3uztpeZ1Wp0W2LlQquXbnpjOyF5QYKDUUYvTCuulljvYi u5tWn5TKlyBL+5CMKIkkFaHYrLRIhy+YfahcGWY2JTV7JajQRIru9S7q2/+c53eec86fQ2Cq GlxNONw+1utmnBQeJ73bn5qS7pqZsOrGFpJMHy72I1PD2Aup6fPQZYnp+f0ruOl1VSu+W2bu DryRm4Ptdbj5a88obq7vbEfm78Fki+wgu6OUZUpYr4Z1F3tKHG57DpVfZMu1GTN1dDqdbcqi NG7GxeZQeQWW9L0OJ9+c0pQzTj+fsjAcR23bucPr8ftYTamH8+VQh2har6V1WVq9Xq81ZBzZ rjfyyFG29E2wsGwi8cTT8WpUiW7Fn0MKAkgD3Hl3Xi7q1fAsegs/h+IIFdmCYHayFxODGgk8 /dYk/VsxcnYgRt1E8KDrHi48KMkE+HkpykMEgZEbYCByXEhjZCq8/9EoFfkogv7BsETk0+DO +BeZoKXkJugJtGKCxvl87/ux5T/jyY0w+nMaCXoVaYXua/P8qHIiidwGveXCl5gwQn1/eBlJ JJ3Q0bOwXKogi6B5eA4JEJDtcujoqJcIswG5HoJhTNwlD54Pv0WiToSPQ50xJ9bBr5bxWG0N gtCVqFQMahFMtlXJRCoDJqeimLjlSji/NBNroITaapUozdA4fFSk98Dckx8x385g8DhyFb+I NIH/rAv8sy7wn3XNCGtHq9kyzmVnOWMZreUYF+d327XFHlcQLR9h2tYuFG3O70MkgagVyhTz hFUlY8q5k64+BARGJSkPTPEpZQlz8hTr9di8fifL9SEj73wDpl5V7OFP2u2z0YZsncGYmaHL oE3Z1BplSttLq4q0Mz72OMuWsd6/dRJCoa5EmYcTDn3vVq99pTv7YcTiGAktLlz3WypSx42h LfLQo/DmfclDnzpz1fpCt0te3xbuW/qtXsyK5O9v3RWejWy9Ha+se3GgYsh24WHXW8fAtbwb 84ODV481HeaYzilf2nR8wVejt8huSN84H6ew3687daliFG1q8Zy2Xj6WXBhJUFBSrpSh0zAv x/wBCR1E8poDAAA= X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFtrAIsWRmVeSWpSXmKPExsVy+t9jAd2cJ3ciDLbc0bN4OeEwo8XEG1dY LN4cn85kcXnXHDaL240r2BxYPXbOusvusWlVJ5vH+31X2Tz6tqxi9Pi8SS6ANcrNJiM1MSW1 SCE1Lzk/JTMv3VYpNMRN10JJIS8xN9VWKULXNyRISaEsMacUyDMyQAMOzgHuwUr6dgluGXc3 BRXcEa44f6uNsYFxPX8XIyeHhICJxMXWI2wQtpjEhXvrgWwuDiGBpYwSO7+vYgdJ8AoISvyY fI+li5GDg1lAXuLIpWwIU11iypRciPIHjBJLjr9lgSjXkth66y0riM0ioCqxb9YKZhCbDSi+ /8UNsF38AooSV388ZgSZIyoQIdF9orKLkZ1DREBfYn8ZyERmgeWMEl/+nQbrFBbIkViz7ztY p5BAG7PE86kxIDanQLDEy6erGScwCs5CcucshDtnIdy5gJF5FaNEakFyQXFSeq5RXmq5XnFi bnFpXrpecn7uJkZwbD2T3sF4eJf7IUYBDkYlHt6KtbcjhFgTy4orcw8xSnAwK4nwcgMjU4g3 JbGyKrUoP76oNCe1+BCjKdCjE5mlRJPzgXGfVxJvaGJuYm5sYGFuaWlipCTO2zj7WbiQQHpi SWp2ampBahFMHxMHp1QDY4NHT9e6mUkfD9zrnHPxTr6hjNcL3bvzPL03vvApX70lQZ0ru8/M RUPy2IXuheJtj5t3Pju8Xop5tcamvESunz7lm4TzTQt3XueIcvT6oHQ28MDChvnzNfzmKHCW 3Vj09s0Gk82G9zbd2ZFfpX94t7HjnJ9q3d/83OZMTJ67iH3ihLbVmxXOMCixFGckGmoxFxUn AgACyrhdwwIAAA== X-MTR: 20000000000000000@CPGS X-CMS-MailID: 20170330105644epcas5p19c682841675e8d291b31ed992a11d5ce X-Msg-Generator: CA X-Sender-IP: 203.254.230.27 X-Local-Sender: =?UTF-8?B?7LWc7LCs7JqwG1RpemVuIFBsYXRmb3JtIExhYihTL1fshLw=?= =?UTF-8?B?7YSwKRvsgrzshLHsoITsnpAbU2VuaW9yIEVuZ2luZWVy?= X-Global-Sender: =?UTF-8?B?Q2hhbndvbyBDaG9pG1RpemVuIFBsYXRmb3JtIExhYi4bU2Ft?= =?UTF-8?B?c3VuZyBFbGVjdHJvbmljcxtTZW5pb3IgRW5naW5lZXI=?= X-Sender-Code: =?UTF-8?B?QzEwG1NUQUYbQzEwVjgxMTE=?= CMS-TYPE: 105P DLP-Filter: Pass X-CFilter-Loop: Reflected X-HopCount: 7 X-CMS-RootMailID: 20170330083943epcas1p4c5559cab13ef732b6bf149f810aa2f46 X-RootMTR: 20170330083943epcas1p4c5559cab13ef732b6bf149f810aa2f46 References: <1490863178-12782-1-git-send-email-cw00.choi@samsung.com> <1490863178-12782-2-git-send-email-cw00.choi@samsung.com> <58DCCEBE.8040401@samsung.com> Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 2017년 03월 30일 19:42, Andy Shevchenko wrote: > On Thu, Mar 30, 2017 at 12:24 PM, Chanwoo Choi wrote: >> On 2017년 03월 30일 18:05, Andy Shevchenko wrote: >>> On Thu, Mar 30, 2017 at 11:39 AM, Chanwoo Choi wrote: >>>> The extcon core already provides the extcon_register_notifier() function >>>> in order to register the notifier block which is used to monitor >>>> the status change for the specific external connector such as EXTCON_USB, >>>> EXTCON_USB_HOST and so on. The extcon consumer uses the this function. >>>> >>>> The extcon consumer may need to monitor the all supported external >>>> connectors from the extcon device. In this case, The extcon consumer >>>> should have each notifier_block structure for each external connector. >>>> >>>> This patch adds the new extcon_register_notifier_all() function >>>> that extcon consumer is able to monitor the status change of all >>>> supported external connectors by using only one notifier_block structure. >>>> >>> >>>> +/** >>>> + * extcon_register_notifier_all() - Register a notifier block to get the noti >>>> + * of the status change for all supported external >>>> + * connectors from extcon. >>>> + * @edev: the extcon device that has the external connecotr. >>>> + * @nb: a notifier block to be registered. >>>> + * >>>> + * Note that the second parameter given to the callback of nb (val) is >>>> + * the current state and third parameter is the edev pointer. >>>> + */ >>> >>> Have you checked how it looks like in resulting document file (man / >>> html / ...) ? >>> My concern is multi-line short function description. >>> >> >> Actually, I didn't consider the document file as you mentioned. >> Do you think need to add more detailed description? > > What I meant is the quite long line in *short* description (fist line > heading with function name). > See Documentation/doc-guide/kernel-doc.rst for the detailed howto. > If you metioned the following guide on Line 111 in the Documentation/doc-guide/kernel-doc.rst, OK. I'll modify it. Example kernel-doc function comment:: /** * foobar() - Brief description of foobar. * @arg: Description of argument of foobar. * * Longer description of foobar. * * Return: Description of return value of foobar. */ int foobar(int arg) -- Best Regards, Chanwoo Choi Samsung Electronics