Messages in this thread | | | Date | Mon, 6 Nov 2017 18:33:55 -0600 | From | Bjorn Helgaas <> | Subject | Re: [PATCH] pci: fix kernel-doc build warning |
| |
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.
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); > >
| |