[lldp-devel] [PATCH 2/2] lldptool: man page fixup

Eric Multanen eric.w.multanen at intel.com
Mon Mar 25 16:21:42 UTC 2013


lldptool-pfc - Remove reference to non-existant parameter
'numtcs' and show 'enableTx' as a parameter.

lldptool-ets - Clarify that the legacy mode of DCBX can
be either CIN or CEE (not just CEE).
 - clarify that the numtcs parameter is read only
 - remove information about using tcfilters for traffic
   classification and add references to net_prio cgroups.

lldptool-dcbx - grammatical fixes
 - clarify that DCBX mode may come in in legacy DCBX in
   certain cases when the IEEE-DCBX tlvid is 'auto'.


lldptool-app - remove note about setting default priority
  not being supported.

Signed-off-by: Eric Multanen <eric.w.multanen at intel.com>
---
 docs/lldptool-app.8  |    4 ----
 docs/lldptool-dcbx.8 |   20 +++++++++++---------
 docs/lldptool-ets.8  |   23 ++++++++++-------------
 docs/lldptool-pfc.8  |    2 +-
 4 files changed, 22 insertions(+), 27 deletions(-)

diff --git a/docs/lldptool-app.8 b/docs/lldptool-app.8
index d8c110a..c75ae39 100644
--- a/docs/lldptool-app.8
+++ b/docs/lldptool-app.8
@@ -49,10 +49,6 @@ Display last transmitted APP TLV on \fIeth2\fR
 o
 IEEE 802.1Qaz (http://www.ieee802.org/1/pages/dcbridges.html)
 
-.SH NOTES
-Currently changing the default priority is not supported by default it
-is set to zero.
-
 .SH SEE ALSO
 .BR lldptool (8),
 .BR lldpad (8)
diff --git a/docs/lldptool-dcbx.8 b/docs/lldptool-dcbx.8
index aaf84bc..a0960a2 100644
--- a/docs/lldptool-dcbx.8
+++ b/docs/lldptool-dcbx.8
@@ -23,11 +23,11 @@ CEE DCBX
 IEEE DCBX
 See the IEEE 802.1Qaz-2011 specification for details."
 .PP
-IEEE DCBX is the default DCBX mode for a DCB capable interface. Therefore the default and configured IEEE DCBX TLV's will be
+IEEE DCBX is the default DCBX mode for a DCB capable interface. Therefore the default and configured IEEE DCBX TLVs will be
 transmitted when the interface comes up.
 .B lldpad
 can be globally configured to support one of the legacy DCBX versions (CIN or CEE).  If the remote LLDP agent does not
-transmit any IEEE DCBX TLV's and does transmit a legacy DCBX TLV which matches the configured legacy DCBX version, then the
+transmit any IEEE DCBX TLVs and does transmit a legacy DCBX TLV which matches the configured legacy DCBX version, then the
 DCBX mode will drop back to legacy DCBX mode.  It will not transition
 back to IEEE DCBX mode until the next link reset.  If 
 .B lldpad
@@ -39,10 +39,12 @@ is restarted and is not persistent across a system reboot.
 .sp
 The DCBX mode can be queried and configured by using the special tlvid
 .B IEEE-DCBX.
-There is not an actual TLV which corresponds to this tlvid.  It's use is to query and reset the IEEE DCBX mode.  When queried,
+There is not an actual TLV which corresponds to this tlvid.  Its use is to query and reset the IEEE DCBX mode.  When queried,
 IEEE DCBX mode can take the following values:
 
-.BR auto " - IEEE DCBX will be used (intially) if lldpad is restarted"
+.BR auto " - IEEE DCBX will be used (intially) if lldpad is restarted.  An exception is if the DCBX mode has been forced to a
+legacy DCBX mode, then the specified legacy mode will be used.  See information about the 'dcbx' parameter in dcbtool(8) for
+more information about this exception."
 .sp
 .BR CEE " - CEE DCBX will be used if lldpad is restarted"
 .sp
@@ -57,13 +59,13 @@ argument to the value
 .B reset
 
 .SH DESCRIPTION - DCBX CONFIGURATION
-The detailed configuration of the IEEE DCBX TLV's can be found in related lldptool man pages for each IEEE DCBX TLV (see
+The detailed configuration of the IEEE DCBX TLVs can be found in related lldptool man pages for each IEEE DCBX TLV (see
 lldptool-pfc(8), lldptool-ets(8) and lldptool-app(8)).
 .sp
-The detailed configuration of the CIN and CEE DCBX TLV's is performed using dcbtool (see dcbtool(8)).  However, lldptool
-can configure the enableTx parameter of the CIN and CEE DCBX TLV's (as it can with most other TLV's).  Since lldpad only
-transmits TLV's for one version of DCBX on any given interface, the enableTx parameter for the CIN and CEE DCBX TLV's (and
-for the IEEE DCBX feature TLV's) takes effect only when the corresponding DCBX version is active.
+The detailed configuration of the CIN and CEE DCBX TLVs is performed using dcbtool (see dcbtool(8)).  However, lldptool
+can configure the enableTx parameter of the CIN and CEE DCBX TLVs (as it can with most other TLVs).  Since lldpad only
+transmits TLVs for one version of DCBX on any given interface, the enableTx parameter for the CIN and CEE DCBX TLVs (and
+for the IEEE DCBX feature TLVs) takes effect only when the corresponding DCBX version is active.
 
 .SH ARGUMENTS
 .TP
diff --git a/docs/lldptool-ets.8 b/docs/lldptool-ets.8
index c3c0908..b0984ec 100644
--- a/docs/lldptool-ets.8
+++ b/docs/lldptool-ets.8
@@ -74,7 +74,7 @@ on. Undefined bandwidths are presumed to be 0.
 .sp
 .TP
 .B numtcs
-Sets/Displays the number of ETS supported traffic classes.
+Displays the number of ETS supported traffic classes.
 
 .SH Theory of Operations
 
@@ -86,22 +86,19 @@ valid configuration is to map all priorities to a single traffic class
 and use the link strict selection algorithm. This is equivalent to
 being in a non-DCB enabled mode.
 
-To support legacy CEE DCBX the ETS-CFG and ETS-REC TLVs are disabled
-if a CEE TLV is received and there are no valid IEEE 802.1Qaz TLVs
-present. At this time the hardware DCBX mode will be set to CEE and
-IEEE mode is disabled. This allows switches to be configured and
+To support legacy DCBX (CIN or CEE) the ETS-CFG and ETS-REC TLVs are disabled
+if a legacy DCBX TLV is received and no valid IEEE DCBX TLVs
+are received. The hardware DCBX mode will also be set to the legacy
+mode and IEEE mode is disabled. This allows switches to be configured and
 end nodes will then be configured accordingly without any configuration 
-required on the end node.
+required on the end node.  See \fIlldpad(8)\fR for more information
+about the operation of the DCBX selection mechanism.
 
 Mapping applications and protocols to traffic classes is required for
 ETS to be useful. User space programs can encode the priority of an
-application with the SO_PRIORITY option. Low level drivers that support
-priority to traffic class mappings may enable this mode by default. For
-drivers that do not support this mode, manual configuration can support
-this mode of operation. See \fItc-mqprio(8)\fR and \fItc-multiq\fR.
-Additionally, tc qdiscs and filters can be used to map protocols to queues
-see \fItc(8)\fR for more details along these lines. Finally, many drivers
-have support for specific protocols ie Fiber Channel over Ethernet (FCoE).
+application with the SO_PRIORITY option. The net_prio cgroup can be
+used to assign application traffic to specific priorities.  See the
+kernel documentation and -fIcgdcbxd(8)\fR for net_prio cgroup information.
 
 .B 
 .SH EXAMPLE & USAGE
diff --git a/docs/lldptool-pfc.8 b/docs/lldptool-pfc.8
index af8a0c2..8a04893 100644
--- a/docs/lldptool-pfc.8
+++ b/docs/lldptool-pfc.8
@@ -2,7 +2,7 @@
 .SH NAME
 PFC \- Show / manipulate PFC TLV configuration
 .SH SYNOPSIS
-.B lldptool -t -i ethx -V PFC [ -c [ willing | enabled | delay | numtcs ] ]
+.B lldptool -t -i ethx -V PFC [ -c [ enableTx | willing | enabled | delay ] ]
 .sp
 .B lldptool -T -i ethx -V PFC
 .RI < CONFIG_ARG=value " " ... >



More information about the lldp-devel mailing list