Re: [PATCH 1/8] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc for Sphinx

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 01/05/18 16:21, Randy Dunlap wrote:
Use '\' escape characters in kernel-doc notation to eliminate a warning
from Sphinx.

../drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h:243: WARNING: Inline strong start-string without end-string.

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc: Doug Ledford <dledford@xxxxxxxxxx>
Cc: Jason Gunthorpe <jgg@xxxxxxxxxxxx>
Cc: linux-doc@xxxxxxxxxxxxxxx
---
  drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h |    2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20171222.orig/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
+++ linux-next-20171222/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
@@ -239,7 +239,7 @@ struct opa_veswport_mactable_entry {
   * @offset: mac table starting offset
   * @num_entries: Number of entries to get or set
   * @mac_tbl_digest: mac table digest
- * @tbl_entries[]: Array of table entries
+ * @tbl_entries\[\]: Array of table entries
   *
   * The EM sends down this structure in a MAD indicating
   * the starting offset in the forwarding table that this

Wouldn't it be better to fix the toolchain such that it escapes Sphinx metacharacters in kernel-doc headers instead of modifying the source code with patches like the above one?

Thanks,

Bart.
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Photo]     [Yosemite News]     [Yosemite Photos]     [Linux Kernel]     [Linux SCSI]     [XFree86]
  Powered by Linux