[Freeciv-Dev] a comment for die()

[Jason Dorje Short <vze49r5w@xxxxxxxxxxx>]

Somehow I committed Raimar's die() patch without a comment for the function.

jason

Index: common/shared.c
===================================================================
RCS file: /home/freeciv/CVS/freeciv/common/shared.c,v
retrieving revision 1.98
diff -u -r1.98 shared.c
--- common/shared.c     2002/12/18 17:36:19     1.98
+++ common/shared.c     2003/02/15 20:04:09
@@ -646,6 +646,11 @@
   return (int) (ret + len);
 }
 
+/***************************************************************************
+  Exit because of a fatal error after printing a message about it.  This
+  should only be called for code errors - user errors (like not being able
+  to find a tileset) should just exit rather than dumping core.
+***************************************************************************/
 void die(const char *format, ...)
 {
   va_list ap;