From 1c1ce14637cdc0d58ecdb34ca8c84cd4969d44ab Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20NOUAILLE=20DEGORCE?=
 <francois.nouaille-degorce@outscale.com>
Date: Wed, 2 Sep 2020 08:50:20 +0000
Subject: [PATCH] wip

---
 doc/README.md |  3 +++
 doc/VHOST.md  | 10 +++++++++-
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/doc/README.md b/doc/README.md
index 5b3367794..26a03c56a 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -15,3 +15,6 @@ For specific brick'informations and shemas:
 * [VTEP brick.](VTEP.md)
 * [SWITCH brick.](SWITCH.md)
 
+About out testing architecture:
+* `wip`
+
diff --git a/doc/VHOST.md b/doc/VHOST.md
index 11a15f181..71807988e 100644
--- a/doc/VHOST.md
+++ b/doc/VHOST.md
@@ -34,6 +34,14 @@ As previously described, VHOST use an unix socket and a hugepage to communicate
 It manages a queue and reduce memmory write/free operatons.<br>
 It's based on a cient(s)/server model, meaning that one server can handle multiple connections through the socket.<br> Only packet address in the hugepage are flowing through the socket.<br>
 
+## How to use it
+
+* `pg_vhost_start("/tmp", &error)`: start the vhost driver and setup the socket's folder.
+* `pg_vhost_new("vhost-0", flags, &error);`: create the brick. The socket will be named `qemu-vhost-0`. Here are some flags availables:
+  * `PG_VHOST_USER_CLIENT`
+  * `PG_VHOST_USER_DEQUEUE_ZERO_COPY`
+
 ## Current VHOST brick's status
 
-Currently the VHOST brick only works in SERVER mode... Which means that if packetgraph crash, we will need to reboot VMs...<br>Not a good thing!
+Currently the VHOST brick only works in SERVER mode... Which means that if packetgraph crash, we will need to reboot VMs...<br>Not a good thing!<br>
+However, a PR in in progress to adress this issue.<br>