lkml.org 
[lkml]   [2017]   [Nov]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH] pci: fix kernel-doc build warning
From
Date
On 11/06/2017 04:33 PM, Bjorn Helgaas wrote:
> On Sun, Oct 29, 2017 at 05:07:11PM -0700, Randy Dunlap wrote:
>> From: Randy Dunlap <rdunlap@infradead.org>
>>
>> Fix build error in kernel-doc notation:
>>
>> ../drivers/pci/pci.c:3479: ERROR: Unexpected indentation.
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Bjorn Helgaas <bhelgaas@google.com>
>> Cc: linux-pci@vger.kernel.org
>> ---
>> drivers/pci/pci.c | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> --- lnx-414-rc7.orig/drivers/pci/pci.c
>> +++ lnx-414-rc7/drivers/pci/pci.c
>> @@ -3471,7 +3471,7 @@ EXPORT_SYMBOL(devm_pci_remap_cfgspace);
>> * All operations are managed and will be undone on driver detach.
>> *
>> * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
>> - * on failure. Usage example:
>> + * on failure. Usage example::
>
> I don't understand what's going on here. Apparently there's something
> special about two colons? I saw plenty of double colons in
> Documentation/, but I couldn't quickly find out what it means.

Sorry about my terseness. The ending colon is not the problem.

The problem is in indentation in the example code, and changing to use
"::" tells the kernel-doc "reStructuredText" processor that the following
block is a literal block of some blob that should be kept as is.

> If kernel-doc thinks "example:" is a mistake, maybe we could recast
> the sentence as "Example usage:"? Putting a double colon here makes
> the text look like a mistake to this human reader.
>
>> *
>> * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
>> * base = devm_pci_remap_cfg_resource(&pdev->dev, res);
>>

Like you said, there will be lots of these "::" in source files.
There is one slight alternate, if it looks any better to you, to put the
"::" on a line by itself, like so:

* Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
* on failure. Usage example:
*::
*
* res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
* base = devm_pci_remap_cfg_resource(&pdev->dev, res);
* if (IS_ERR(base))
* return PTR_ERR(base);
*/


I can resend the patch like that if you prefer it.

thanks,
--
~Randy

\
 
 \ /
  Last update: 2017-11-08 20:59    [W:0.193 / U:0.264 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site