[ofa-general] [PATCH ibverbs] Do not use enum object types for bitfields

Jason Gunthorpe jgunthorpe at obsidianresearch.com
Thu Jul 23 14:29:28 PDT 2009


On Thu, Jul 23, 2009 at 02:09:11PM -0700, Roland Dreier wrote:
> Thanks... I guess we can take a stab at doing this and see if anyone
> breaks because of it.
> 
> I do notice that this patch doesn't update the man pages and therefore
> leaves them out of sync with the actual code.  And that makes me notice
> that by going from "enum ibv_foo foo" to "int foo" we lose the nice
> self-documenting property of the API that it tells you what set of
> flags

Oops, I forgot to do those, I'll re-send the patch. Well, I'll try, my
nroff is terrible..

> are supposed to be used there.  I guess we should make sure that at
> least all the interfaces in verbs.h used by applications (as opposed to
> driver stuff in driver.h) document what enum contains the flags that go
> into each parameter.

A good man page should list and describe each of the constants that
are valid, a reference to the enum is not necessary. I will try and
look at this too..

Jason



More information about the general mailing list