From dfc2cb4e31d6756b2d6ca7f87e80d8913751a4b7 Mon Sep 17 00:00:00 2001
From: Simon Hengel <sol@typeful.net>
Date: Sun, 14 Oct 2012 11:58:13 +0200
Subject: Allow haddock markup in deprecation messages

---
 tests/html-tests/tests/BugDeprecated.html.ref      | 18 +++++++++-----
 tests/html-tests/tests/BugExportHeadings.html.ref  |  9 ++++---
 tests/html-tests/tests/DeprecatedClass.html.ref    | 12 ++++++----
 tests/html-tests/tests/DeprecatedData.html.ref     | 18 +++++++++-----
 tests/html-tests/tests/DeprecatedFunction.hs       |  8 +++++--
 tests/html-tests/tests/DeprecatedFunction.html.ref | 28 ++++++++++++++++++++--
 .../html-tests/tests/DeprecatedFunction2.html.ref  |  3 ++-
 .../html-tests/tests/DeprecatedFunction3.html.ref  |  3 ++-
 tests/html-tests/tests/DeprecatedModule.hs         |  2 +-
 tests/html-tests/tests/DeprecatedModule.html.ref   |  5 +++-
 tests/html-tests/tests/DeprecatedModule2.html.ref  |  3 ++-
 tests/html-tests/tests/DeprecatedNewtype.html.ref  | 12 ++++++----
 tests/html-tests/tests/DeprecatedRecord.html.ref   |  3 ++-
 .../html-tests/tests/DeprecatedTypeFamily.html.ref |  6 +++--
 .../tests/DeprecatedTypeSynonym.html.ref           |  6 +++--
 tests/html-tests/tests/ModuleWithWarning.hs        |  2 +-
 tests/html-tests/tests/ModuleWithWarning.html.ref  |  5 +++-
 .../tests/mini_DeprecatedFunction.html.ref         |  6 +++++
 18 files changed, 110 insertions(+), 39 deletions(-)

(limited to 'tests')

diff --git a/tests/html-tests/tests/BugDeprecated.html.ref b/tests/html-tests/tests/BugDeprecated.html.ref
index f632d670..913b189d 100644
--- a/tests/html-tests/tests/BugDeprecated.html.ref
+++ b/tests/html-tests/tests/BugDeprecated.html.ref
@@ -96,7 +96,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_BugDeprecated.html");}
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: for foo</p
+	      >Deprecated: for foo
+</p
 	      ></div
 	    ></div
 	  ></div
@@ -110,7 +111,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_BugDeprecated.html");}
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: for baz</p
+	      >Deprecated: for baz
+</p
 	      ></div
 	    ></div
 	  ></div
@@ -124,7 +126,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_BugDeprecated.html");}
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: for bar</p
+	      >Deprecated: for bar
+</p
 	      ></div
 	    ></div
 	  ></div
@@ -138,7 +141,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_BugDeprecated.html");}
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: for one</p
+	      >Deprecated: for one
+</p
 	      ></div
 	    ><p
 	    >some documentation for one, two and three
@@ -155,7 +159,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_BugDeprecated.html");}
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: for three</p
+	      >Deprecated: for three
+</p
 	      ></div
 	    ><p
 	    >some documentation for one, two and three
@@ -172,7 +177,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_BugDeprecated.html");}
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: for two</p
+	      >Deprecated: for two
+</p
 	      ></div
 	    ><p
 	    >some documentation for one, two and three
diff --git a/tests/html-tests/tests/BugExportHeadings.html.ref b/tests/html-tests/tests/BugExportHeadings.html.ref
index d3298b2e..457e2c50 100644
--- a/tests/html-tests/tests/BugExportHeadings.html.ref
+++ b/tests/html-tests/tests/BugExportHeadings.html.ref
@@ -166,7 +166,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_BugExportHeadings.html
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: for one</p
+	      >Deprecated: for one
+</p
 	      ></div
 	    ></div
 	  ></div
@@ -183,7 +184,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_BugExportHeadings.html
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: for two</p
+	      >Deprecated: for two
+</p
 	      ></div
 	    ></div
 	  ></div
@@ -200,7 +202,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_BugExportHeadings.html
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: for three</p
+	      >Deprecated: for three
+</p
 	      ></div
 	    ></div
 	  ></div
diff --git a/tests/html-tests/tests/DeprecatedClass.html.ref b/tests/html-tests/tests/DeprecatedClass.html.ref
index 21806843..d716c1d8 100644
--- a/tests/html-tests/tests/DeprecatedClass.html.ref
+++ b/tests/html-tests/tests/DeprecatedClass.html.ref
@@ -90,7 +90,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedClass.html")
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: SomeClass</p
+	      >Deprecated: SomeClass
+</p
 	      ></div
 	    ><p
 	    >some class
@@ -106,7 +107,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedClass.html")
 	    ><div class="doc"
 	    ><div class="warning"
 	      ><p
-		>Deprecated: foo</p
+		>Deprecated: foo
+</p
 		></div
 	      ><p
 	      >documentation for foo
@@ -126,7 +128,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedClass.html")
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: SomeOtherClass</p
+	      >Deprecated: SomeOtherClass
+</p
 	      ></div
 	    ></div
 	  ><div class="subs methods"
@@ -139,7 +142,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedClass.html")
 	    ><div class="doc"
 	    ><div class="warning"
 	      ><p
-		>Deprecated: bar</p
+		>Deprecated: bar
+</p
 		></div
 	      ></div
 	    ></div
diff --git a/tests/html-tests/tests/DeprecatedData.html.ref b/tests/html-tests/tests/DeprecatedData.html.ref
index c7ea7579..24758345 100644
--- a/tests/html-tests/tests/DeprecatedData.html.ref
+++ b/tests/html-tests/tests/DeprecatedData.html.ref
@@ -92,7 +92,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedData.html");
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: Foo</p
+	      >Deprecated: Foo
+</p
 	      ></div
 	    ><p
 	    >type Foo
@@ -110,7 +111,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedData.html");
 		><td class="doc"
 		><div class="warning"
 		  ><p
-		    >Deprecated: Foo</p
+		    >Deprecated: Foo
+</p
 		    ></div
 		  ><p
 		  >constructor Foo
@@ -125,7 +127,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedData.html");
 		><td class="doc"
 		><div class="warning"
 		  ><p
-		    >Deprecated: Bar</p
+		    >Deprecated: Bar
+</p
 		    ></div
 		  ><p
 		  >constructor Bar
@@ -145,7 +148,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedData.html");
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: One</p
+	      >Deprecated: One
+</p
 	      ></div
 	    ></div
 	  ><div class="subs constructors"
@@ -160,7 +164,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedData.html");
 		><td class="doc"
 		><div class="warning"
 		  ><p
-		    >Deprecated: One</p
+		    >Deprecated: One
+</p
 		    ></div
 		  ></td
 		></tr
@@ -172,7 +177,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedData.html");
 		><td class="doc"
 		><div class="warning"
 		  ><p
-		    >Deprecated: Two</p
+		    >Deprecated: Two
+</p
 		    ></div
 		  ></td
 		></tr
diff --git a/tests/html-tests/tests/DeprecatedFunction.hs b/tests/html-tests/tests/DeprecatedFunction.hs
index 55416369..8d626435 100644
--- a/tests/html-tests/tests/DeprecatedFunction.hs
+++ b/tests/html-tests/tests/DeprecatedFunction.hs
@@ -1,6 +1,10 @@
 module DeprecatedFunction where
 
--- | some documentation foo
+-- | some documentation for foo
 foo :: Int
 foo = 23
-{-# DEPRECATED foo "use bar instead" #-}
+{-# DEPRECATED foo "use `bar` instead" #-}
+
+-- | some documentation for bar
+bar :: Int
+bar = 42
diff --git a/tests/html-tests/tests/DeprecatedFunction.html.ref b/tests/html-tests/tests/DeprecatedFunction.html.ref
index a44d2265..1fc678bb 100644
--- a/tests/html-tests/tests/DeprecatedFunction.html.ref
+++ b/tests/html-tests/tests/DeprecatedFunction.html.ref
@@ -51,6 +51,12 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedFunction.htm
 	    > :: <a href=""
 	    >Int</a
 	    ></li
+	  ><li class="src short"
+	  ><a href=""
+	    >bar</a
+	    > :: <a href=""
+	    >Int</a
+	    ></li
 	  ></ul
 	></div
       ><div id="interface"
@@ -66,10 +72,28 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedFunction.htm
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: use bar instead</p
+	      >Deprecated: use <code
+		><a href=""
+		  >bar</a
+		  ></code
+		> instead
+</p
 	      ></div
 	    ><p
-	    >some documentation foo
+	    >some documentation for foo
+</p
+	    ></div
+	  ></div
+	><div class="top"
+	><p class="src"
+	  ><a name="v:bar" class="def"
+	    >bar</a
+	    > :: <a href=""
+	    >Int</a
+	    ></p
+	  ><div class="doc"
+	  ><p
+	    >some documentation for bar
 </p
 	    ></div
 	  ></div
diff --git a/tests/html-tests/tests/DeprecatedFunction2.html.ref b/tests/html-tests/tests/DeprecatedFunction2.html.ref
index 5b8c8b6c..b5068c8e 100644
--- a/tests/html-tests/tests/DeprecatedFunction2.html.ref
+++ b/tests/html-tests/tests/DeprecatedFunction2.html.ref
@@ -66,7 +66,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedFunction2.ht
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: use bar instead</p
+	      >Deprecated: use bar instead
+</p
 	      ></div
 	    ></div
 	  ></div
diff --git a/tests/html-tests/tests/DeprecatedFunction3.html.ref b/tests/html-tests/tests/DeprecatedFunction3.html.ref
index 942e12b8..f24eb666 100644
--- a/tests/html-tests/tests/DeprecatedFunction3.html.ref
+++ b/tests/html-tests/tests/DeprecatedFunction3.html.ref
@@ -66,7 +66,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedFunction3.ht
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: use bar instead</p
+	      >Deprecated: use bar instead
+</p
 	      ></div
 	    ></div
 	  ></div
diff --git a/tests/html-tests/tests/DeprecatedModule.hs b/tests/html-tests/tests/DeprecatedModule.hs
index 61a09d64..369dba4f 100644
--- a/tests/html-tests/tests/DeprecatedModule.hs
+++ b/tests/html-tests/tests/DeprecatedModule.hs
@@ -1,5 +1,5 @@
 -- | Documentation for "DeprecatedModule".
-module DeprecatedModule {-# DEPRECATED "Use Foo instead" #-} where
+module DeprecatedModule {-# DEPRECATED "Use \"Foo\" instead" #-} where
 
 foo :: Int
 foo = 23
diff --git a/tests/html-tests/tests/DeprecatedModule.html.ref b/tests/html-tests/tests/DeprecatedModule.html.ref
index 7c035bf9..0ca4fafe 100644
--- a/tests/html-tests/tests/DeprecatedModule.html.ref
+++ b/tests/html-tests/tests/DeprecatedModule.html.ref
@@ -47,7 +47,10 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedModule.html"
 	><div class="doc"
 	><div class="warning"
 	  ><p
-	    >Deprecated: Use Foo instead</p
+	    >Deprecated: Use <a href=""
+	      >Foo</a
+	      > instead
+</p
 	    ></div
 	  ><p
 	  >Documentation for <a href=""
diff --git a/tests/html-tests/tests/DeprecatedModule2.html.ref b/tests/html-tests/tests/DeprecatedModule2.html.ref
index c2a61074..0a313ae9 100644
--- a/tests/html-tests/tests/DeprecatedModule2.html.ref
+++ b/tests/html-tests/tests/DeprecatedModule2.html.ref
@@ -47,7 +47,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedModule2.html
 	><div class="doc"
 	><div class="warning"
 	  ><p
-	    >Deprecated: Use Foo instead</p
+	    >Deprecated: Use Foo instead
+</p
 	    ></div
 	  ></div
 	></div
diff --git a/tests/html-tests/tests/DeprecatedNewtype.html.ref b/tests/html-tests/tests/DeprecatedNewtype.html.ref
index 2a854dd9..521ffb92 100644
--- a/tests/html-tests/tests/DeprecatedNewtype.html.ref
+++ b/tests/html-tests/tests/DeprecatedNewtype.html.ref
@@ -80,7 +80,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedNewtype.html
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: SomeNewType</p
+	      >Deprecated: SomeNewType
+</p
 	      ></div
 	    ><p
 	    >some documentation
@@ -100,7 +101,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedNewtype.html
 		><td class="doc"
 		><div class="warning"
 		  ><p
-		    >Deprecated: SomeNewTypeConst</p
+		    >Deprecated: SomeNewTypeConst
+</p
 		    ></div
 		  ><p
 		  >constructor docu 
@@ -120,7 +122,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedNewtype.html
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: SomeOtherNewType</p
+	      >Deprecated: SomeOtherNewType
+</p
 	      ></div
 	    ></div
 	  ><div class="subs constructors"
@@ -137,7 +140,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedNewtype.html
 		><td class="doc"
 		><div class="warning"
 		  ><p
-		    >Deprecated: SomeOtherNewTypeConst</p
+		    >Deprecated: SomeOtherNewTypeConst
+</p
 		    ></div
 		  ></td
 		></tr
diff --git a/tests/html-tests/tests/DeprecatedRecord.html.ref b/tests/html-tests/tests/DeprecatedRecord.html.ref
index 77839ca7..9ade8377 100644
--- a/tests/html-tests/tests/DeprecatedRecord.html.ref
+++ b/tests/html-tests/tests/DeprecatedRecord.html.ref
@@ -122,7 +122,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedRecord.html"
 		      ><dd class="doc"
 		      ><div class="warning"
 			><p
-			  >Deprecated: do not use this</p
+			  >Deprecated: do not use this
+</p
 			  ></div
 			><p
 			>some value
diff --git a/tests/html-tests/tests/DeprecatedTypeFamily.html.ref b/tests/html-tests/tests/DeprecatedTypeFamily.html.ref
index cd091802..ffc069a6 100644
--- a/tests/html-tests/tests/DeprecatedTypeFamily.html.ref
+++ b/tests/html-tests/tests/DeprecatedTypeFamily.html.ref
@@ -72,7 +72,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedTypeFamily.h
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: SomeTypeFamily</p
+	      >Deprecated: SomeTypeFamily
+</p
 	      ></div
 	    ><p
 	    >some documentation
@@ -89,7 +90,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedTypeFamily.h
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: SomeOtherTypeFamily</p
+	      >Deprecated: SomeOtherTypeFamily
+</p
 	      ></div
 	    ></div
 	  ></div
diff --git a/tests/html-tests/tests/DeprecatedTypeSynonym.html.ref b/tests/html-tests/tests/DeprecatedTypeSynonym.html.ref
index e148012a..665dcf5d 100644
--- a/tests/html-tests/tests/DeprecatedTypeSynonym.html.ref
+++ b/tests/html-tests/tests/DeprecatedTypeSynonym.html.ref
@@ -78,7 +78,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedTypeSynonym.
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: TypeSyn</p
+	      >Deprecated: TypeSyn
+</p
 	      ></div
 	    ><p
 	    >some documentation
@@ -97,7 +98,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_DeprecatedTypeSynonym.
 	  ><div class="doc"
 	  ><div class="warning"
 	    ><p
-	      >Deprecated: OtherTypeSyn</p
+	      >Deprecated: OtherTypeSyn
+</p
 	      ></div
 	    ></div
 	  ></div
diff --git a/tests/html-tests/tests/ModuleWithWarning.hs b/tests/html-tests/tests/ModuleWithWarning.hs
index 2114bac6..e64d9d7e 100644
--- a/tests/html-tests/tests/ModuleWithWarning.hs
+++ b/tests/html-tests/tests/ModuleWithWarning.hs
@@ -1,5 +1,5 @@
 -- | Documentation for "ModuleWithWarning".
-module ModuleWithWarning {-# WARNING "This is an unstable interface." #-} where
+module ModuleWithWarning {-# WARNING "This is an unstable interface.  Prefer functions from \"Prelude\" instead!" #-} where
 
 foo :: Int
 foo = 23
diff --git a/tests/html-tests/tests/ModuleWithWarning.html.ref b/tests/html-tests/tests/ModuleWithWarning.html.ref
index 6a427259..348f0822 100644
--- a/tests/html-tests/tests/ModuleWithWarning.html.ref
+++ b/tests/html-tests/tests/ModuleWithWarning.html.ref
@@ -47,7 +47,10 @@ window.onload = function () {pageLoad();setSynopsis("mini_ModuleWithWarning.html
 	><div class="doc"
 	><div class="warning"
 	  ><p
-	    >Warning: This is an unstable interface.</p
+	    >Warning: This is an unstable interface.  Prefer functions from <a href=""
+	      >Prelude</a
+	      > instead!
+</p
 	    ></div
 	  ><p
 	  >Documentation for <a href=""
diff --git a/tests/html-tests/tests/mini_DeprecatedFunction.html.ref b/tests/html-tests/tests/mini_DeprecatedFunction.html.ref
index 17d3e526..9bb90dac 100644
--- a/tests/html-tests/tests/mini_DeprecatedFunction.html.ref
+++ b/tests/html-tests/tests/mini_DeprecatedFunction.html.ref
@@ -25,6 +25,12 @@ window.onload = function () {pageLoad();};
 	  >foo</a
 	  ></p
 	></div
+      ><div class="top"
+      ><p class="src"
+	><a href="" target="main"
+	  >bar</a
+	  ></p
+	></div
       ></div
     ></body
   ></html
-- 
cgit v1.2.3