From d89dfb1b264b1cc418a589625a3ccbaceafb8173 Mon Sep 17 00:00:00 2001
From: "John L. Villalovos" <john.l.villalovos@intel.com>
Date: Fri, 24 Jun 2016 13:00:12 -0700
Subject: [PATCH] Documentation follow-up to the LLDP patch
Documentation follow-up to the LLDP patch, commit
a7f0af722f96950e3bf67e26b922f80c1bd503ab. Provide the meaning of the
acronymns TLV and LLDP.
Change-Id: Icce3eb5519dfcfc9b6f7e23003cf056646da6c50
---
doc/source/index.rst | 11 ++++++-----
ironic_python_agent/hardware.py | 4 ++--
2 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 2891382a4..76aa5df53 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -111,11 +111,12 @@ fields:
``interfaces``
list of network interfaces with fields: ``name``, ``mac_address``,
``ipv4_address``, ``lldp``. If configuration option ``collect_lldp`` is
- set to True the ``lldp`` field will be populated by a list of TLVs pulled
- from LLDP. Currently IPA also returns 2 fields ``switch_port_descr`` and
- ``switch_chassis_descr`` which were reserved for future use, these are now
- deprecated to be removed in Ocata in favor of including all LLDP data in
- the ``lddp`` field.
+ set to True the ``lldp`` field will be populated by a list of
+ type-length-value (TLV) fields retrieved using the Link Layer Discovery
+ Protocol (LLDP). Currently IPA also returns 2 fields ``switch_port_descr``
+ and ``switch_chassis_descr`` which were reserved for future use, these are
+ now deprecated to be removed in Ocata in favor of including all LLDP data
+ in the ``lddp`` field.
``system_vendor``
system vendor information from SMBIOS as reported by ``dmidecode``:
diff --git a/ironic_python_agent/hardware.py b/ironic_python_agent/hardware.py
index c8ac8f449..203245ddc 100644
--- a/ironic_python_agent/hardware.py
+++ b/ironic_python_agent/hardware.py
@@ -457,8 +457,8 @@ class GenericHardwareManager(HardwareManager):
# to get data to replace it so just return.
return
for ifname, tlvs in raw_lldp_data.items():
- # NOTE(sambetts) Convert each tlv value to hex so that it can be
- # serialised safely
+ # NOTE(sambetts) Convert each type-length-value (TLV) value to hex
+ # so that it can be serialised safely
processed_tlvs = []
for typ, data in tlvs:
try: