[Lxr-commits] CVS: lxr/lib/LXR Common.pm,1.108,1.109

[Andre-Littoz <ajl...@us...>]

Update of /cvsroot/lxr/lxr/lib/LXR
In directory sfp-cvs-1.v30.ch3.sourceforge.com:/tmp/cvs-serv2303/lib/LXR

Modified Files:
	Common.pm 
Log Message:
Common.pm: sync comment for sub warning with new debugging possibility

Index: Common.pm
===================================================================
RCS file: /cvsroot/lxr/lxr/lib/LXR/Common.pm,v
retrieving revision 1.108
retrieving revision 1.109
diff -u -d -r1.108 -r1.109
--- Common.pm	9 Nov 2013 19:37:11 -0000	1.108
+++ Common.pm	3 Dec 2013 09:59:54 -0000	1.109
@@ -119,6 +119,27 @@
 may not yet have been emitted if this is an error on the page header
 template.>
 
+B<Note:>
+
+=over
+
+=item
+
+I<Since it proved a valuable debuging aid, the function has been modified
+so that it can be used very early in LXR initialisation.
+Variable C<$HTMLheadOK> tells if the "standard" header part of the
+page has already been sent to screen.
+If not, some general purpose header is emitted to support HTML layout
+of the warning message.>
+
+I<Of course, when the standard header part is later emitted,
+some of its components will be discarded (or not properly set) by the browser
+because they occur at an inappropriate location (not HTML-compliant).
+This happens only in exceptional circumstances, usually requiring
+fix by the LXR administrator.>
+
+=back
+
 =cut
 
 sub warning {
@@ -170,7 +191,7 @@
 are printed before the message
 and the HTML page is properly closed.
 
-I<Note>:
+B<Note>:
 
 =over
 
@@ -339,7 +360,7 @@
 
 =back
 
-Notes:
+B<Notes:>
 
 =over