diff options
Diffstat (limited to 'extras/libmemif/docs')
| -rw-r--r-- | extras/libmemif/docs/buildinstructions_doc.md (renamed from extras/libmemif/docs/BuildInstructions.md) | 5 | ||||
| -rw-r--r-- | extras/libmemif/docs/gettingstarted_doc.md (renamed from extras/libmemif/docs/GettingStarted.md) | 14 |
2 files changed, 12 insertions, 7 deletions
diff --git a/extras/libmemif/docs/BuildInstructions.md b/extras/libmemif/docs/buildinstructions_doc.md index 9bb59b94..838e835a 100644 --- a/extras/libmemif/docs/BuildInstructions.md +++ b/extras/libmemif/docs/buildinstructions_doc.md @@ -1,4 +1,4 @@ -## Build Instructions +## Build Instructions {#libmemif_build_doc} Install dependencies ``` @@ -49,6 +49,7 @@ commands: ip-set <index> <ip-addr> - set interface ip address rx-mode <index> <qid> <polling|interrupt> - set queue rx mode ``` + #### Examples -Once the library is build/installed, refer to [Examples](../examples/README.md) and [Getting started](GettingStarted.md) for additional information on basic use cases and API usage. +Once the library is built/installed, refer to @ref libmemif_examples_doc and @ref libmemif_gettingstarted_doc for additional information on basic use cases and API usage. diff --git a/extras/libmemif/docs/GettingStarted.md b/extras/libmemif/docs/gettingstarted_doc.md index 3cc0ceb0..e3ae6e56 100644 --- a/extras/libmemif/docs/GettingStarted.md +++ b/extras/libmemif/docs/gettingstarted_doc.md @@ -1,8 +1,8 @@ -## Getting started +## Getting started {#libmemif_gettingstarted_doc} #### Concept (Connecting to VPP) -For detailed information on api calls and structures please refer to [libmemif.h](../src/libmemif.h) +For detailed information on api calls and structures please refer to @ref libmemif.h. 1. Initialize memif - Declare callback function handling file descriptor event polling. @@ -152,7 +152,8 @@ if (err != MEMIF_ERR_SUCCESS) #### Example app (libmemif fd event polling): -- [ICMP Responder](../examples/icmp_responder/main.c) +- @ref extras/libmemif/examples/icmp_responder + > Optional argument: transmit queue id. ``` icmpr 1 @@ -162,11 +163,14 @@ icmpr 1 #### Example app: -- [ICMP Responder custom fd event polling](../examples/icmp_responder-epoll/main.c) +ICMP Responder custom fd event polling. + +- @ref extras/libmemif/examples/icmp_responder-epoll #### Example app (multi-thread queue polling) -- [ICMP Responder multi-thread](../examples/icmp_responder-mt/main.c) +ICMP Responder multi-thread. +- @ref extras/libmemif/examples/icmp_responder-mt > Simple example of libmemif multi-thread usage. Connection establishment is handled by main thread. There are two rx queues in this example. One in polling mode and second in interrupt mode. |