* [PATCH 1/8] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc for Sphinx
[not found] ` <15151980023293-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
@ 2018-01-06 0:20 ` Randy Dunlap
0 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2018-01-06 0:20 UTC (permalink / raw)
To: Randy Dunlap, linux-rdma-u79uwXL29TY76Z2rM5mHXA
Cc: Doug Ledford, Jason Gunthorpe, linux-doc-u79uwXL29TY76Z2rM5mHXA
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH 1/8] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc for Sphinx
@ 2018-01-06 0:21 Randy Dunlap
[not found] ` <5a50168d.4a9b620a.2c596.4dfd-ATjtLOhZ0NVl57MIdRCFDg@public.gmane.org>
0 siblings, 1 reply; 5+ messages in thread
From: Randy Dunlap @ 2018-01-06 0:21 UTC (permalink / raw)
To: linux-rdma-u79uwXL29TY76Z2rM5mHXA, 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 <rdunlap-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
Cc: Doug Ledford <dledford-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
Cc: Jason Gunthorpe <jgg-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org>
Cc: linux-doc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
---
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
--
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 1/8] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc for Sphinx
[not found] ` <5a50168d.4a9b620a.2c596.4dfd-ATjtLOhZ0NVl57MIdRCFDg@public.gmane.org>
@ 2018-01-06 0:38 ` Bart Van Assche
[not found] ` <c7e46f04-ac60-448f-3e5d-e23fe7221c9a-Sjgp3cTcYWE@public.gmane.org>
0 siblings, 1 reply; 5+ messages in thread
From: Bart Van Assche @ 2018-01-06 0:38 UTC (permalink / raw)
To: Randy Dunlap, linux-rdma-u79uwXL29TY76Z2rM5mHXA, Randy Dunlap
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-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
> Cc: Doug Ledford <dledford-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
> Cc: Jason Gunthorpe <jgg-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org>
> Cc: linux-doc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> ---
> 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-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 1/8] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc for Sphinx
[not found] ` <c7e46f04-ac60-448f-3e5d-e23fe7221c9a-Sjgp3cTcYWE@public.gmane.org>
@ 2018-01-09 13:46 ` Dennis Dalessandro
[not found] ` <719e4232-3802-b2ab-99d5-2c4ba45bfd40-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
0 siblings, 1 reply; 5+ messages in thread
From: Dennis Dalessandro @ 2018-01-09 13:46 UTC (permalink / raw)
To: Bart Van Assche, Randy Dunlap, linux-rdma-u79uwXL29TY76Z2rM5mHXA,
Randy Dunlap
On 1/5/2018 7:38 PM, Bart Van Assche wrote:
> 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-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
>> Cc: Doug Ledford <dledford-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
>> Cc: Jason Gunthorpe <jgg-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org>
>> Cc: linux-doc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
>> ---
>> 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?
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 majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 1/8] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc for Sphinx
[not found] ` <719e4232-3802-b2ab-99d5-2c4ba45bfd40-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
@ 2018-01-09 20:40 ` Randy Dunlap
0 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2018-01-09 20:40 UTC (permalink / raw)
To: Dennis Dalessandro, Bart Van Assche, Randy Dunlap,
linux-rdma-u79uwXL29TY76Z2rM5mHXA
On 01/09/18 05:46, Dennis Dalessandro wrote:
> On 1/5/2018 7:38 PM, Bart Van Assche wrote:
>> 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-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
>>> Cc: Doug Ledford <dledford-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
>>> Cc: Jason Gunthorpe <jgg-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org>
>>> Cc: linux-doc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
>>> ---
>>> 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?
>
> I tend to agree with Bart here.
OK, I'll drop this patch also.
thanks,
--
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2018-01-09 20:40 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-01-06 0:21 [PATCH 1/8] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc for Sphinx Randy Dunlap
[not found] ` <5a50168d.4a9b620a.2c596.4dfd-ATjtLOhZ0NVl57MIdRCFDg@public.gmane.org>
2018-01-06 0:38 ` Bart Van Assche
[not found] ` <c7e46f04-ac60-448f-3e5d-e23fe7221c9a-Sjgp3cTcYWE@public.gmane.org>
2018-01-09 13:46 ` Dennis Dalessandro
[not found] ` <719e4232-3802-b2ab-99d5-2c4ba45bfd40-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2018-01-09 20:40 ` Randy Dunlap
-- strict thread matches above, loose matches on Subject: below --
2018-01-06 0:20 [PATCH 0/8] Infiniband: clean up kernel-doc and add driver-api chapter Randy Dunlap
[not found] ` <15151980023293-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
2018-01-06 0:20 ` [PATCH 1/8] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc for Sphinx Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox