Re: [PATCH V1 rdma-core 6/7] mlx5: Add direct verbs man pages

[Leon Romanovsky <leonro-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org>]

[-- Attachment #1: Type: text/plain, Size: 1579 bytes --]

On Mon, Feb 13, 2017 at 09:54:45AM -0700, Jason Gunthorpe wrote:
> On Sun, Feb 12, 2017 at 04:16:51PM +0200, Yishai Hadas wrote:
>
> > +.\" -*- nroff -*-
> > +.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
>
> Please use the MIT variant for all new files
>
> > +.fi
> > +.SH "RETURN VALUE"
> > +0 on success.
>
> 'or the value of errno on failure (which indicates the failure reason)'
>
> and in other places.
>
> > +.BI "int mlx5dv_query_device(struct ibv_context *ctx_in,
> > +.BI "                        struct mlx5dv_context *attrs_out);
>
> This isn't going to work with comp_mask, at a minimum you need to add
> a size_t attrs_len argument.
>
> I recommend against adding new complex queries like this - they don't
> work well from an ABI perspective and not being performance critical
> do not require this comp_max madness
>
> Eg just use:
>
> int mlx5dv_query_cq_format(struct ibv_context *ctx_in)

This will end with bazillion small exported functions and I don't think
that it is clean way to provide API. Especially for function which
should query_device.

>
> We still need man pages for all the inline functions :|

There is documentation in the include file itself. It is hard to imagine
users are working with these functions without good knowledge of mlx5
HW. They don't need man pages :).

>
> Jason
> --
> 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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]