Patchwork [Open-FCoE,2/2] fipvlan: Add documentation for VN2VN VLAN discovery

login
register
mail settings
Submitter Mark Rustad
Date May 17, 2013, 6:51 p.m.
Message ID <20130517185106.12840.38909.stgit@host1-mdrustad.localdomain>
Download mbox | patch
Permalink /patch/46/
State Accepted
Headers show

Comments

Mark Rustad - May 17, 2013, 6:51 p.m.
Update the fipvlan documention to include the new -m/--mode
option enabling VN2VN VLAN discovery.

Signed-off-by: Mark Rustad <mark.d.rustad@intel.com>
Tested-by: Jack Morgan<jack.morgan@intel.com>
---
 doc/fipvlan.8   |   13 +++++++++----
 doc/fipvlan.txt |    8 ++++++--
 2 files changed, 15 insertions(+), 6 deletions(-)

Patch

diff --git a/doc/fipvlan.8 b/doc/fipvlan.8
index 5b2a2c2..f81cb3a 100644
--- a/doc/fipvlan.8
+++ b/doc/fipvlan.8
@@ -2,12 +2,12 @@ 
 .\"     Title: fipvlan
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 02/06/2013
+.\"      Date: 03/18/2013
 .\"    Manual: Open-FCoE Tools
 .\"    Source: Open-FCoE
 .\"  Language: English
 .\"
-.TH "FIPVLAN" "8" "02/06/2013" "Open\-FCoE" "Open\-FCoE Tools"
+.TH "FIPVLAN" "8" "03/18/2013" "Open\-FCoE" "Open\-FCoE Tools"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -29,9 +29,9 @@ 
 fipvlan \- Fibre Channel over Ethernet VLAN Discovery
 .SH "SYNOPSIS"
 .sp
-\fBfipvlan\fR [\-c|\-\-create] [\-s|\-\-start] \fIinterfaces\fR
+\fBfipvlan\fR [\-c|\-\-create] [\-s|\-\-start] [\-m|\-\-mode fabric|vn2vn] \fIinterfaces\fR
 .sp
-\fBfipvlan\fR \-a|\-\-auto [\-c|\-\-create] [\-d|\-\-debug] [\-s|\-\-start] [\-l|\-\-link\-retry \fIcount\fR]
+\fBfipvlan\fR \-a|\-\-auto [\-c|\-\-create] [\-d|\-\-debug] [\-s|\-\-start] [\-m|\-\-mode fabric|vn2vn] [\-l|\-\-link\-retry \fIcount\fR]
 .sp
 \fBfipvlan\fR \-h|\-\-help
 .sp
@@ -67,6 +67,11 @@  Start the
 initiator on discovered FCoE VLANs
 .RE
 .PP
+\fB\-m\fR, \fB\-\-mode\fR
+.RS 4
+fabric|vn2vn Specify whether VLAN discovery is performed in the default fabric mode, or in VN2VN mode\&.
+.RE
+.PP
 \fB\-f\fR, \fB\-\-suffix\fR \fIsuffix\fR
 .RS 4
 Append the specified string
diff --git a/doc/fipvlan.txt b/doc/fipvlan.txt
index fc63536..9699197 100644
--- a/doc/fipvlan.txt
+++ b/doc/fipvlan.txt
@@ -19,10 +19,10 @@  fipvlan - Fibre Channel over Ethernet VLAN Discovery
 
 SYNOPSIS
 --------
-*fipvlan* [-c|--create] [-s|--start] _interfaces_
+*fipvlan* [-c|--create] [-s|--start] [-m|--mode fabric|vn2vn] _interfaces_
 
 *fipvlan* -a|--auto [-c|--create] [-d|--debug]
- [-s|--start] [-l|--link-retry _count_]
+ [-s|--start] [-m|--mode fabric|vn2vn] [-l|--link-retry _count_]
 
 *fipvlan* -h|--help
 
@@ -64,6 +64,10 @@  OPTIONS
 *-s*, *--start*::
 	Start the _Open-FCoE_ initiator on discovered FCoE VLANs
 
+*-m*, *--mode*:: fabric|vn2vn
+	Specify whether VLAN discovery is performed in the default
+	fabric mode, or in VN2VN mode.
+
 *-f*, *--suffix* _suffix_::
 	Append the specified string _suffix_ to VLAN interface names.