PCI: Fix kernel-doc build warning
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 30 Oct 2017 00:07:11 +0000 (17:07 -0700)
committerBjorn Helgaas <bhelgaas@google.com>
Wed, 8 Nov 2017 23:22:28 +0000 (17:22 -0600)
Fix build error in kernel-doc notation:

  ../drivers/pci/pci.c:3479: ERROR: Unexpected indentation.

"::" tells the kernel-doc "reStructuredText" processor that the following
block is a literal block of some blob that should be kept as is.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
[bhelgaas: add hint about "::" meaning]
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
drivers/pci/pci.c

index 6078dfc..d50c58d 100644 (file)
@@ -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::
  *
  *     res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  *     base = devm_pci_remap_cfg_resource(&pdev->dev, res);