From 0e730e4fa316cbfbd2d6dc60276498f57f500e0e Mon Sep 17 00:00:00 2001
From: Pierre Courtieu
Date: Mon, 15 Dec 2014 20:56:07 +0100
Subject: Changed bullet informations to warning for better display in PG.

Since it displays together with the goal, it is better (for pg and
other interfaces probably) that they are in a different message.
---
 lib/pp.ml  |  4 ++++
 lib/pp.mli | 10 ++++++++++
 2 files changed, 14 insertions(+)

(limited to 'lib')

diff --git a/lib/pp.ml b/lib/pp.ml
index d7ae31dd3b..44036ca996 100644
--- a/lib/pp.ml
+++ b/lib/pp.ml
@@ -447,6 +447,10 @@ let logger = ref std_logger
 let feedback_id = ref (Feedback.Edit 0)
 let feedback_route = ref Feedback.default_route
 
+(* If mixing some output and a goal display, please use msg_warning,
+   so that interfaces (proofgeneral for example) can easily dispatch
+   them to different windows. *)
+
 let msg_info x = !logger ~id:!feedback_id Info x
 let msg_notice x = !logger ~id:!feedback_id Notice x
 let msg_warning x = !logger ~id:!feedback_id Warning x
diff --git a/lib/pp.mli b/lib/pp.mli
index fd529e1d79..d4314a3366 100644
--- a/lib/pp.mli
+++ b/lib/pp.mli
@@ -122,6 +122,16 @@ type message = Feedback.message = {
 
 type logger = message_level -> std_ppcmds -> unit
 
+(** {6 output functions}
+
+[msg_info] and [msg_notice] do not put any decoration on output by
+default. If possible don't mix them with goal output (prefer
+msg_warning) so that dispatching of outputs is easier. Once all
+interfaces use the xml-like protocol this constraint can be
+relaxed. *)
+(* Should we advertise these functions more? Should they be the ONLY
+   allowed way to output something? *)
+
 val msg_info : std_ppcmds -> unit
 (** Message that displays information, usually in verbose mode, such as [Foobar
     is defined] *)
-- 
cgit v1.2.3