Add documentation for rte_ring mempool driver.
Signed-off-by: Konstantin Ananyev <konstantin.anan...@intel.com>
---
doc/guides/mempool/index.rst | 1 +
doc/guides/mempool/ring.rst | 34 ++++++++++++++++++++++++++++++++++
2 files changed, 35 insertions(+)
create mode 100644 doc/guides/mempool/ring.rst
diff --git a/doc/guides/mempool/index.rst b/doc/guides/mempool/index.rst
index 756610264..bbd02fd81 100644
--- a/doc/guides/mempool/index.rst
+++ b/doc/guides/mempool/index.rst
@@ -13,3 +13,4 @@ application through the mempool API.
octeontx
octeontx2
+ ring
diff --git a/doc/guides/mempool/ring.rst b/doc/guides/mempool/ring.rst
new file mode 100644
index 000000000..b8659c03f
--- /dev/null
+++ b/doc/guides/mempool/ring.rst
@@ -0,0 +1,34 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2020 Intel Corporation.
+
+Ring Mempool Driver
+==============================
+
+**rte_mempool_ring** is a pure SW mempool driver based on ``rte_ring``
+DPDK library. This is a default mempool driver.
+Following modes of operation are available for ``ring`` mempool driver
+and can be selected via mempool ops API:
+
+- ``ring_mp_mc``
+
+ Underlying **rte_ring** operates in multi-thread producer,
+ multi-thread consumer sync mode.
+
+- ``ring_sp_sc``
+
+ Underlying **rte_ring** operates in single-thread producer,
+ single-thread consumer sync mode.
+
+- ``ring_sp_mc``
+
+ Underlying **rte_ring** operates in single-thread producer,
+ multi-thread consumer sync mode.
+
+- ``ring_mp_sc``
+
+ Underlying **rte_ring** operates in multi-thread producer,
+ single-thread consumer sync mode.
+
+
+For more information about ``rte_ring`` structure, behaviour and available
+synchronisation modes please refer to: :doc:`../prog_guide/ring_lib`.
--
2.17.1
