From d216bd85b4a1c6804256d1a28e92c8305dac1bc2 Mon Sep 17 00:00:00 2001
From: Mrmaxmeier <Mrmaxmeier@gmail.com>
Date: Fri, 28 Jun 2024 11:56:17 +0200
Subject: [PATCH] document DW_FORM_string restriction

---
 src/write/line.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/write/line.rs b/src/write/line.rs
index d673e941..02a507ff 100644
--- a/src/write/line.rs
+++ b/src/write/line.rs
@@ -981,6 +981,10 @@ pub struct FileInfo {
     /// Optionally some embedded sourcecode.
     ///
     /// Only used if version >= 5 and `LineProgram::file_has_source` is `true`.
+    ///
+    /// NOTE: This currently only supports the `LineString::String` variant,
+    /// since we're encoding the string with `DW_FORM_string`.
+    /// Other variants will result in an `LineStringFormMismatch` error.
     pub source: Option<LineString>,
 }