document DW_FORM_string restriction

gimli-rs · Jun 28, 2024 · d216bd8 · d216bd8
1 parent be0080a
commit d216bd8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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>,
 }