summaryrefslogtreecommitdiff
path: root/lib/kernel/overlay_ini.mli
diff options
context:
space:
mode:
Diffstat (limited to 'lib/kernel/overlay_ini.mli')
-rw-r--r--lib/kernel/overlay_ini.mli9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/kernel/overlay_ini.mli b/lib/kernel/overlay_ini.mli
index bace93b..321cac1 100644
--- a/lib/kernel/overlay_ini.mli
+++ b/lib/kernel/overlay_ini.mli
@@ -32,6 +32,15 @@
Dates take three forms, matching {!Date_spec}: [MM-DD], [easter+N] or
[easter-N], and [mon/day/nth] such as [oct/sun/1] or [oct/sun/-1]. *)
+(** One [section] of a flat INI file. Exposed so other libraries (the language
+ and config files) reuse this reader rather than growing a second one that
+ would drift in its comment, quoting and trimming rules. *)
+type section = { name : string; fields : (string * string) list }
+
+(** Split INI text into sections. [\[section\]] headers, [key = value] lines,
+ ';' and '#' comments, blank lines ignored. Never raises. *)
+val parse_sections : string -> (section list, string) result
+
(** [parse ~rank_of_string text] is the overlay [text] denotes.
[rank_of_string] is supplied by the rite, exactly as [Overlay.load] takes