diff --git a/tools/README.md b/tools/README.md index 43c9606bc..523047b51 100644 --- a/tools/README.md +++ b/tools/README.md @@ -7,19 +7,25 @@ All other directories are useful tools ported from FreeBSD. # ipc This is a simple implemention using dpdk `rte_ring`. -`ff_ipc_msg_alloc` get msg structure from rte_mempool. -`ff_ipc_msg_free` put msg to rte_mempool. -`ff_ipc_send` enqueue msg to rte_ring. -`ff_ipc_recv` dequeue msg from rte_ring. +``` +ff_ipc_msg_alloc: get msg structure from rte_mempool. +ff_ipc_msg_free: put msg to rte_mempool. +ff_ipc_send: enqueue msg to rte_ring. +ff_ipc_recv: dequeue msg from rte_ring. +``` Since F-Stack is multi-process architecture and every process has an independent stack, so we must communicate with every F-Stack process. # sysctl Usage: -`sysctl -p [-bdehiNnoqTtWx] [ -B ] [-f filename] name[=value] ...` -`sysctl -p [-bdehNnoqTtWx] [ -B ] -a` +``` +sysctl -p [-bdehiNnoqTtWx] [ -B ] [-f filename] name[=value] ... +sysctl -p [-bdehNnoqTtWx] [ -B ] -a +``` - -p Which F-Stack process to communicate with, default 0. +``` +-p Which F-Stack process to communicate with, default 0. +``` Except this option, it is same with the original FreeBSD sysctl, see [Manual page](https://www.freebsd.org/cgi/man.cgi?sysctl). @@ -117,4 +123,4 @@ TOPDIR?=${CURDIR}/../.. PROG=helloworld include ${TOPDIR}/tools/prog.mk -``` \ No newline at end of file +```