From f6d2ac5bd5edcd7cc9b824eab37186ee4d8fa9d9 Mon Sep 17 00:00:00 2001
From: cxhong <abcdqiu@gmail.com>
Date: Fri, 28 Feb 2020 15:44:46 -0500
Subject: [PATCH] update documentation for nicextraparams

---
 .../common/deployment/network/cfg_network_extra_param.rst     | 4 ++++
 docs/source/guides/admin-guides/references/man5/nics.5.rst    | 2 ++
 docs/source/guides/admin-guides/references/man7/group.7.rst   | 2 ++
 docs/source/guides/admin-guides/references/man7/node.7.rst    | 2 ++
 4 files changed, 10 insertions(+)

diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_extra_param.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_extra_param.rst
index 74e33d59e..6934cbec2 100644
--- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_extra_param.rst
+++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_extra_param.rst
@@ -19,3 +19,7 @@ Use ``nicextraparams`` to customize attributes in NIC configuration file. For ex
       HWADDR=42:f5:0a:05:6a:09
       MTU=1456
 
+  #. Example to add `nicextraparams` to `bond` interface ::
+
+      chdef cn1 nicextraparams.bond0='BONDING_OPTS="mode=active-backup;abc=100" MTU=6400 XYZ="4800" IOP="mode=1 phase=2"'
+
diff --git a/docs/source/guides/admin-guides/references/man5/nics.5.rst b/docs/source/guides/admin-guides/references/man5/nics.5.rst
index 3ef6f1716..53e790c3c 100644
--- a/docs/source/guides/admin-guides/references/man5/nics.5.rst
+++ b/docs/source/guides/admin-guides/references/man5/nics.5.rst
@@ -121,6 +121,8 @@ nics Attributes:
                      <nic1>!<param1=value1 param2=value2>,<nic2>!<param3=value3>, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes.
                  If multiple ip addresses are associated with each NIC:
                      <nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
+The semicolon-separated is needed if there are multiple values for extra parameters:
+                     bond0!BONDING_OPTS=lacp_rate=1;miimon=100;mode=802.3ad
              The xCAT object definition commands support to use nicextraparams.<nicname> as the sub attributes.
  
 
diff --git a/docs/source/guides/admin-guides/references/man7/group.7.rst b/docs/source/guides/admin-guides/references/man7/group.7.rst
index 98c2710d1..acd170df1 100644
--- a/docs/source/guides/admin-guides/references/man7/group.7.rst
+++ b/docs/source/guides/admin-guides/references/man7/group.7.rst
@@ -629,6 +629,8 @@ group Attributes:
                      <nic1>!<param1=value1 param2=value2>,<nic2>!<param3=value3>, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes.
                  If multiple ip addresses are associated with each NIC:
                      <nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
+The semicolon-separated is needed if there are multiple values for extra parameters:
+                     bond0!BONDING_OPTS=lacp_rate=1;miimon=100;mode=802.3ad
              The xCAT object definition commands support to use nicextraparams.<nicname> as the sub attributes.
  
 
diff --git a/docs/source/guides/admin-guides/references/man7/node.7.rst b/docs/source/guides/admin-guides/references/man7/node.7.rst
index d94e998b7..01452050b 100644
--- a/docs/source/guides/admin-guides/references/man7/node.7.rst
+++ b/docs/source/guides/admin-guides/references/man7/node.7.rst
@@ -629,6 +629,8 @@ node Attributes:
                      <nic1>!<param1=value1 param2=value2>,<nic2>!<param3=value3>, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes.
                  If multiple ip addresses are associated with each NIC:
                      <nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
+The semicolon-separated is needed if there are multiple values for extra parameters:
+                     bond0!BONDING_OPTS=lacp_rate=1;miimon=100;mode=802.3ad
              The xCAT object definition commands support to use nicextraparams.<nicname> as the sub attributes.