On Wed, Mar 11, 2020 at 7:45 PM Jason Gunthorpe <jgg@xxxxxxxx> wrote: > > On Wed, Mar 11, 2020 at 05:12:16PM +0100, Jack Wang wrote: > > diff --git a/drivers/infiniband/ulp/rtrs/rtrs.h b/drivers/infiniband/ulp/rtrs/rtrs.h > > new file mode 100644 > > index 000000000000..395d1112f155 > > +++ b/drivers/infiniband/ulp/rtrs/rtrs.h > > > + > > +/** > > + * rtrs_clt_open() - Open a session to an RTRS server > > + * @ops: holds the link event callback and the private pointer. > > + * @sessname: name of the session > > + * @paths: Paths to be established defined by their src and dst addresses > > + * @path_cnt: Number of elements in the @paths array > > + * @port: port to be used by the RTRS session > > + * @pdu_sz: Size of extra payload which can be accessed after permit allocation. > > + * @max_inflight_msg: Max. number of parallel inflight messages for the session > > + * @max_segments: Max. number of segments per IO request > > + * @reconnect_delay_sec: time between reconnect tries > > + * @max_reconnect_attempts: Number of times to reconnect on error before giving > > + * up, 0 for * disabled, -1 for forever > > + * > > + * Starts session establishment with the rtrs_server. The function can block > > + * up to ~2000ms before it returns. > > + * > > + * Return a valid pointer on success otherwise PTR_ERR. > > + */ > > It is not so major, but the linux standard is for kdocs to be in the > .c files not the header - to make an index of kdocs for browsing I > think the sphinx stuff is supposed to be used. > > Jason Thanks for the quick reply. Bart suggested the same in the past, we thought kdocs in .c or .h both are fine. To make the sphinx stuff happy, we will move the kdoc to .c file. Regards!
