infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc for Sphinx
PATCH 1/8 infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc for Sphinx
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.
--- drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h +1 -1
@@ -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
Signature · 4 lines
-- To unsubscribe from this list: send the line "unsubscribe linux-rdma" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
A message that is not in the archive (sent off-list or not yet received): 5a50168d.4a9b620a.2c596.4dfd-ATjtLOhZ0NVl57MIdRCFDg@public.gmane.org
Quoted 16 lines · Randy Dunlap
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 <[email protected]>Cc Doug Ledford <[email protected]>Cc Jason Gunthorpe <jgg-VPRAkNaXOzVWk0Htik3J/[email protected]>--- drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h struct opa_veswport_mactable_entry { · line 245
Quoted 8 lines
drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h +1
-1@@ -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 [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
A message that is not in the archive (sent off-list or not yet received): c7e46f04-ac60-448f-3e5d-e23fe7221c9a-Sjgp3cTcYWE@public.gmane.org
Quoted 14 lines · Bart Van Assche
Quoted 13 lines · Randy Dunlap
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 <[email protected]>Cc Doug Ledford <[email protected]>Cc Jason Gunthorpe <jgg-VPRAkNaXOzVWk0Htik3J/[email protected]>---
drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h| 2 +-1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 14 lines
drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h struct opa_veswport_mactable_entry { · line 245
Quoted 12 lines
---
linux-next-20171222.orig/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h+++linux-next-20171222/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.hdrivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h +1
-1@@ -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 thisWouldn'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?
I tend to agree with Bart here.
-Denny
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
A message that is not in the archive (sent off-list or not yet received): 719e4232-3802-b2ab-99d5-2c4ba45bfd40-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org
Quoted 29 lines · Dennis Dalessandro
Quoted 14 lines · Bart Van Assche
Quoted 13 lines · Randy Dunlap
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 <[email protected]>Cc Doug Ledford <[email protected]>Cc Jason Gunthorpe <jgg-VPRAkNaXOzVWk0Htik3J/[email protected]>---
drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h| 2 +-1 file changed, 1 insertion(+), 1 deletion(-)Quoted 13 lines
drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h struct opa_veswport_mactable_entry { · line 245
Quoted 11 lines
drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h +1
-1@@ -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 thisWouldn'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?
Quoted 1 line
I tend to agree with Bart here.
OK, I'll drop this patch also.
thanks,
Signature · 5 lines
~Randy -- To unsubscribe from this list: send the line "unsubscribe linux-rdma" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html