From e53b9f5992450b53efc886b4fa9ca16f3dd07530 Mon Sep 17 00:00:00 2001
From: Kelly Brazil <kellyjonbrazil@gmail.com>
Date: Wed, 13 May 2020 10:12:40 -0700
Subject: [PATCH] add caveats to documentation

---
 jc/parsers/dmidecode.py | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/jc/parsers/dmidecode.py b/jc/parsers/dmidecode.py
index 13a8838b..02ff9542 100644
--- a/jc/parsers/dmidecode.py
+++ b/jc/parsers/dmidecode.py
@@ -4,6 +4,43 @@ Usage:
 
     specify --dmidecode as the first argument if the piped input is coming from dmidecode
 
+    Note: Because the output of dmidecode has some quirks, there may (rarely) be some missing data.
+          For example, with mixed single and multi-line items only the first item is output.
+
+          this:
+            Associated Memory Slots: 2
+                0x0006
+                0x0007
+
+          is converted to:
+            "associated_memory_slots": "2",
+
+          Very rarely there is an item with multiple sub-items and descriptions. These items will
+          become corrupted.
+
+          this:
+            Handle 0x019F, DMI type 10, 8 bytes
+            On Board Device 1 Information
+                    Type: Video
+                    Status: Disabled
+                    Description: VMware SVGA II
+            On Board Device 2 Information
+                    Type: Sound
+                    Status: Disabled
+                    Description: ES1371
+
+          is converted to:
+            {
+                "handle": "0x019F",
+                "type": 10,
+                "bytes": 8,
+                "description": "On Board Device 1 Information",
+                "values": {
+                  "type": "Sound",
+                  "status": "Disabled",
+                  "description": "ES1371"
+            }
+
 Compatibility:
 
     'linux'