eventdev: improve docs of start function
authorHarry van Haaren <harry.van.haaren@intel.com>
Thu, 30 Mar 2017 19:30:29 +0000 (20:30 +0100)
committerJerin Jacob <jerin.jacob@caviumnetworks.com>
Tue, 4 Apr 2017 17:19:51 +0000 (19:19 +0200)
commitd924782d84d45717fec6cada688f9439df766a95
treea869deb3dfafe951d721352175f78d25fa6403ed
parente36abf8efe4d9e9af89d02482e031cbad10b3ece
eventdev: improve docs of start function

This commit documents two error return values for the
rte_event_dev_start() function.

-ESTALE  indicates not all ports are configured
-ENOLINK indicates that not all queues are linked to ports. If an
         application enqueues to such a queue it can lead to deadlock

Suggested-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
lib/librte_eventdev/rte_eventdev.h