Re: [PATCH RFC v2] Documentation/infiniband: Add docs for rdma-helpers

2015-05-19 Thread Michael Wang
On 05/18/2015 06:58 PM, Doug Ledford wrote: [snip] >> I see :-) I've not work with the kdoc yet, not sure if there is any >> guidelines on how to write the header of inline func for kdoc? > > It's an automated tool thing. Any comment section that starts with /** > is automatically included as a

Re: [PATCH RFC v2] Documentation/infiniband: Add docs for rdma-helpers

2015-05-18 Thread Doug Ledford
On Mon, 2015-05-18 at 17:27 +0200, Michael Wang wrote: > > On 05/18/2015 05:21 PM, Doug Ledford wrote: > [snip] > >> > >> I'll put the highlights and changelog under '---' in next version, is it > >> looks like this? > > > > We're still missing Jason's feedback request though. Specifically, he >

Re: [PATCH RFC v2] Documentation/infiniband: Add docs for rdma-helpers

2015-05-18 Thread Michael Wang
On 05/18/2015 05:21 PM, Doug Ledford wrote: [snip] >> >> I'll put the highlights and changelog under '---' in next version, is it >> looks like this? > > We're still missing Jason's feedback request though. Specifically, he > pointed out that kdocs are usually not done in Documentation/*, they

Re: [PATCH RFC v2] Documentation/infiniband: Add docs for rdma-helpers

2015-05-18 Thread Doug Ledford
On Mon, 2015-05-18 at 12:06 +0200, Michael Wang wrote: > Hi, Or > > On 05/18/2015 11:47 AM, Or Gerlitz wrote: > [snip] > >> Highlights: > >> There could be many missing/mistakes/misunderstanding, please don't > >> be hesitate to point out the issues, any suggestions to improve or > >> comple

Re: [PATCH RFC v2] Documentation/infiniband: Add docs for rdma-helpers

2015-05-18 Thread Michael Wang
Hi, Or On 05/18/2015 11:47 AM, Or Gerlitz wrote: [snip] >> Highlights: >> There could be many missing/mistakes/misunderstanding, please don't >> be hesitate to point out the issues, any suggestions to improve or >> complete the description are very welcomed ;-) > > Michael, none of what you

Re: [PATCH RFC v2] Documentation/infiniband: Add docs for rdma-helpers

2015-05-18 Thread Or Gerlitz
On Mon, May 18, 2015 at 11:41 AM, Michael Wang wrote: > Since v1: > * Merge the descriptions from Doug: > http://www.spinics.net/lists/linux-rdma/msg25172.html > > This is the following patch for: > https://lkml.org/lkml/2015/5/5/417 > which try to document the settled rdma_cap_XX(). > > H

[PATCH RFC v2] Documentation/infiniband: Add docs for rdma-helpers

2015-05-18 Thread Michael Wang
Since v1: * Merge the descriptions from Doug: http://www.spinics.net/lists/linux-rdma/msg25172.html This is the following patch for: https://lkml.org/lkml/2015/5/5/417 which try to document the settled rdma_cap_XX(). Highlights: There could be many missing/mistakes/misunderstanding, ple