Roland Dreier wrote:

A few comments about documentation:

There seem to be two distinct requests in this thread. First, there
is a desire for a basic verbs example that can be used to get
started. I am writing code like this as I develop the userspace verbs
library, since I need basic tests to make sure the library works.
There will be at least a couple of examples packaged and released as
part of libibverbs.


This would be really helpful to many people. I would also suggest that as the userspace verbs is written by you and others, to document and make available your testing code. This will get users a foothold.

Second, there is a request for comprehensive documentation that covers
the complete verbs API. This is a much larger undertaking. I am
looking at ways I can make this happen, but it is difficult to figure
out how I can put enough time in to make it happen in a reasonable
amount of time. I'm also not sure that type of documentation some
people might want is even possible -- it will never be possible to
have a cookbook that says "set field X to value Y and your app will go
fast;" the reason field X can take different values is because the
correct value depends on the particular app. It will never be
possible to get high performance without a deep understanding of both
IB and the app being tuned.


I understand that this is difficult. But describing the basics and providing examples would sure help. At least explaining what the fields actually mean in the documentation (i.e. what the tend to effect) would be a huge improvement.

Of course, these are just my opinions, but I strongly believe I echo *many* end users.

-Mike
_______________________________________________
openib-general mailing list
openib-general@openib.org
http://openib.org/mailman/listinfo/openib-general

To unsubscribe, please visit http://openib.org/mailman/listinfo/openib-general

Reply via email to