The interface naming depends on the AUTO_VLAN setting in the
configuration file, so we should state as much in the manual
page.

Signed-off-by: Hannes Reinecke <[email protected]>
---
 doc/fcoeadm.8   |    9 +++++++++
 doc/fcoeadm.txt |    9 +++++++++
 2 files changed, 18 insertions(+)

diff --git a/doc/fcoeadm.8 b/doc/fcoeadm.8
index 6dd6d9b..a7c4c71 100644
--- a/doc/fcoeadm.8
+++ b/doc/fcoeadm.8
@@ -135,6 +135,15 @@ Displays the version of the
 \fBfcoeadm\fR
 command\&.
 .RE
+.SH "INTERFACE NAMES"
+.sp
+The actual name for \fIethX\fR depends on the \fBAUTO_VLAN\fR setting in
+the fcoemon interface configuration (/etc/fcoe/cfg-ethX, see \fBfcoemon\fR)\&.
+.sp
+If \fBAUTO_VLAN\fR is set to \fIyes\fR, the interface name \fIethX\fR
+references the network device itself. If \fBAUTO_VLAN\fR is set to
+\fIno\fR, the interface name \fIethX\fR references the VLAN device\&.
+.RE
 .SH "EXAMPLES"
 .sp
 Creates an FCoE instance on eth2\&.101
diff --git a/doc/fcoeadm.txt b/doc/fcoeadm.txt
index 40348ab..927acd6 100644
--- a/doc/fcoeadm.txt
+++ b/doc/fcoeadm.txt
@@ -121,6 +121,15 @@ OPTIONS
 *-v*, *--version*::
        Displays the version of the *fcoeadm* command.
 
+INTERFACE NAMES
+---------------
+The actual name for _ethX_ depends on the *AUTO_VLAN* setting in the fcoemon
+interface configuration (/etc/fcoe/cfg-ethX, see *fcoemon*).
+
+If *AUTO_VLAN* is set to _yes_, the interface name _ethX_ references the
+network device itself. If *AUTO_VLAN* is set to _no_, the interface
+name _ethX_ references the VLAN device.
+
 EXAMPLES
 --------
 Creates an FCoE instance on eth2.101
-- 
1.7.10.4

_______________________________________________
fcoe-devel mailing list
[email protected]
http://lists.open-fcoe.org/mailman/listinfo/fcoe-devel

Reply via email to