Skip to content

Commit

Permalink
Improve phy_port argument documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
anujkaliaiitd committed Jun 14, 2019
1 parent c28496d commit 36e7673
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/rpc.h
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,11 @@ class Rpc {
* \param sm_handler The session management callback that is invoked when
* sessions are successfully created or destroyed.
*
* @param phy_port An Rpc object uses one physical port. This is the
* zero-based index of that port among active ports.
* @param phy_port An Rpc object uses one physical port on the NIC. phy_port
* is the zero-based index of that port among active ports, as listed by
* `ibv_devinfo` for Raw, InfiniBand, and RoCE transports; or by
* `dpdk-devbind` for DPDK transport.
*
* @throw runtime_error if construction fails
*/
Rpc(Nexus *nexus, void *context, uint8_t rpc_id, sm_handler_t sm_handler,
Expand Down

0 comments on commit 36e7673

Please sign in to comment.