From 244325118c336be72df8bbd47cb3302aafe8d319 Mon Sep 17 00:00:00 2001
From: Hamdy Khader <hamdyk@mellanox.com>
Date: Wed, 9 Nov 2016 15:41:40 +0200
Subject: [PATCH] Added "Limitations" section, change version to 3.2.1 in docs

Change-Id: I3c0eab8311bee1f58ee5f97550fa34797a35880c
---
 doc/source/conf.py              | 4 ++--
 doc/source/index.rst            | 2 +-
 doc/source/installation.rst     | 7 +++----
 doc/source/overview.rst         | 6 ++++++
 doc/source/supported_images.rst | 2 +-
 5 files changed, 13 insertions(+), 8 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index bf9de10..d0b5d0f 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -57,7 +57,7 @@ copyright = u'2016, mellanox'
 # The short X.Y version.
 version = '3.2'
 # The full version, including alpha/beta/rc tags.
-release = '3.2-3.2.0-1'
+release = '3.2-3.2.1-1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -238,7 +238,7 @@ latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[e
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'fuel-plugin-mellanox', u'Guide to the Mellanox ConnectX-4 plugin ver. 3.2-3.2.0-1 for Fuel 8',
+    ('index', 'fuel-plugin-mellanox', u'Guide to the Mellanox ConnectX-4 plugin ver. 3.2-3.2.1-1 for Fuel 8',
      [u'Mellanox'], 1)
 ]
 
diff --git a/doc/source/index.rst b/doc/source/index.rst
index e0d893a..ce3191f 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 =====================================================================
-Guide to the Mellanox ConnectX-4 Plugin ver. 3.2-3.2.0-1 for Fuel
+Guide to the Mellanox ConnectX-4 Plugin ver. 3.2-3.2.1-1 for Fuel
 =====================================================================
 
 User documentation
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 681e14e..ccb6d1d 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -11,19 +11,19 @@ To install Mellanox plugin, follow these steps:
 #. Download the plugin rpm file for MOS 8.0 from `Fuel Plugin Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins>`_.
 #. Copy the plugin on already installed Fuel Master. scp can be used for that.::
 
-   # scp mellanox-plugin-3.2-3.2.0-1.noarch.rpm root@<Fuel_Master_ip>:/tmp
+   # scp mellanox-plugin-3.2-3.2.1-1.noarch.rpm root@<Fuel_Master_ip>:/tmp
 
 #. Install the plugin::
 
    # cd /tmp
-   # fuel plugins --install mellanox-plugin-3.2-3.2.0-1.noarch.rpm
+   # fuel plugins --install mellanox-plugin-3.2-3.2.1-1.noarch.rpm
 
 #. Verify the plugin was installed successfully by having it listed using ``fuel plugins`` command::
 
    # fuel plugins
    #  id | name              | version | package_version
    #  ---|-------------------|---------|----------------
-   #  1  | mellanox-plugin   | 3.2.0   | 3.0.0
+   #  1  | mellanox-plugin   | 3.2.1   | 3.0.0
 
 #. Define bootstrap discovery parameters to be burnt on Mellanox Adapters cards:
 
@@ -170,4 +170,3 @@ To install Mellanox plugin, follow these steps:
 #. When using SR-IOV you can set the number of virtual NICs (virtual functions) to up to 31
    if your hardware and system capabilities like memory and BIOS support it).
    In any case of SR-IOV hardware limitation, the installation will try to fallback a VF number to the default of 16 VFs.
-
diff --git a/doc/source/overview.rst b/doc/source/overview.rst
index 591db5c..49e553b 100644
--- a/doc/source/overview.rst
+++ b/doc/source/overview.rst
@@ -47,3 +47,9 @@ Requirements
  (e.g. SN2700 (ETH), SB7700 (IB)). The switch ports should be configured specifically to use 100 Gb speed. No
  additional configuration is required on the adapter side.
 
+Limitations
+-----------
+| 1. when using iSER and bonding, the storage interface will be a virtual function under the first
+ port, and will not support failover.
+| 2. when using SR-IOV and bonding, the virtual functions will be created and allocated from the
+ first interface, and failover is not supported.
diff --git a/doc/source/supported_images.rst b/doc/source/supported_images.rst
index 49bec3c..be885b7 100644
--- a/doc/source/supported_images.rst
+++ b/doc/source/supported_images.rst
@@ -15,4 +15,4 @@ Supported images
 |   3   | Cirros Mellanox    | 3.11.0-26-generic               |
 +-------+--------------------+---------------------------------+
 
-This Fuel Mellanox plugin ver. 3.2-3.2.0-1 is using MLNX_OFED_LINUX version 3.3-1.5.0.
+This Fuel Mellanox plugin ver. 3.2-3.2.1-1 is using MLNX_OFED_LINUX version 3.3-1.5.0.