12/02/2018 15:19, Adrien Mazarguil: > On Mon, Feb 12, 2018 at 02:58:31PM +0100, Thomas Monjalon wrote: > > 12/02/2018 12:23, Adrien Mazarguil: > > > On Fri, Feb 09, 2018 at 05:39:50PM +0100, Thomas Monjalon wrote: > > > > I think it's better to have some random thoughts than nothing. > > > > All the comments you gave in this thread deserve to be written in > > > > the documentation as soon as possible. > > > > > > Right, but as a side note in the meantime, more complete documentation is > > > already available in Doxygen format in mlx4_flow.c. *All* limitations are > > > also returned in plain text through error messages > > > (rte_flow_error.message) > > > in the same file (git grep 'msg =' drivers/net/mlx4/mlx4_flow.c). > > > > OK, so we can just point to this file in the documentation and we are done. > > One remaining issue is that we do not generate documentation out of PMDs > since they do not expose public APIs. We can still somehow point to their > source code though.
Yes, just mention the source code where the information is. It can help. And if you or Ophir think there is some outstanding limitations, we can just add a note with a sentence like: "One of the limitation important to be aware of is..."