Author: jtn
Date: Sun Sep 25 17:02:33 2016
New Revision: 33884

URL: http://svn.gna.org/viewcvs/freeciv?rev=33884&view=rev
Log:
Update maintenance comments in Lua script files to reflect that APIs may
be in use in savegames so can't be changed for a long time.

Modified:
    trunk/common/scriptcore/tolua_common_a.pkg
    trunk/common/scriptcore/tolua_common_z.pkg
    trunk/common/scriptcore/tolua_game.pkg
    trunk/common/scriptcore/tolua_signal.pkg
    trunk/server/scripting/tolua_server.pkg

Modified: trunk/common/scriptcore/tolua_common_a.pkg
URL: 
http://svn.gna.org/viewcvs/freeciv/trunk/common/scriptcore/tolua_common_a.pkg?rev=33884&r1=33883&r2=33884&view=diff
==============================================================================
--- trunk/common/scriptcore/tolua_common_a.pkg  (original)
+++ trunk/common/scriptcore/tolua_common_a.pkg  Sun Sep 25 17:02:33 2016
@@ -13,9 +13,11 @@
 
 /*****************************************************************************
   ADVERTISEMENT: do not attempt to change the name of the API functions.
-  They *must* be compatible between the minor Freeciv versions within the
-  same major version. If you really like to change a function name, be sure
-  to keep also the old one running.
+  They may be in use in Lua scripts in savefiles, so once released, the
+  name and signature cannot change shape even in new major versions of
+  Freeciv, until the relevant save format version can no longer be loaded.
+  If you really like to change a function name, be sure to keep also the
+  old one running.
 *****************************************************************************/
 
 $#ifdef HAVE_CONFIG_H

Modified: trunk/common/scriptcore/tolua_common_z.pkg
URL: 
http://svn.gna.org/viewcvs/freeciv/trunk/common/scriptcore/tolua_common_z.pkg?rev=33884&r1=33883&r2=33884&view=diff
==============================================================================
--- trunk/common/scriptcore/tolua_common_z.pkg  (original)
+++ trunk/common/scriptcore/tolua_common_z.pkg  Sun Sep 25 17:02:33 2016
@@ -13,9 +13,11 @@
 
 /*****************************************************************************
   ADVERTISEMENT: do not attempt to change the name of the API functions.
-  They *must* be compatible between the minor Freeciv versions within the
-  same major version. If you really like to change a function name, be sure
-  to keep also the old one running.
+  They may be in use in Lua scripts in savefiles, so once released, the
+  name and signature cannot change shape even in new major versions of
+  Freeciv, until the relevant save format version can no longer be loaded.
+  If you really like to change a function name, be sure to keep also the
+  old one running.
 *****************************************************************************/
 
 $#ifdef HAVE_CONFIG_H

Modified: trunk/common/scriptcore/tolua_game.pkg
URL: 
http://svn.gna.org/viewcvs/freeciv/trunk/common/scriptcore/tolua_game.pkg?rev=33884&r1=33883&r2=33884&view=diff
==============================================================================
--- trunk/common/scriptcore/tolua_game.pkg      (original)
+++ trunk/common/scriptcore/tolua_game.pkg      Sun Sep 25 17:02:33 2016
@@ -13,9 +13,11 @@
 
 /*****************************************************************************
   ADVERTISEMENT: do not attempt to change the name of the API functions.
-  They *must* be compatible between the minor Freeciv versions within the
-  same major version. If you really like to change a function name, be sure
-  to keep also the old one running.
+  They may be in use in Lua scripts in savefiles, so once released, the
+  name and signature cannot change shape even in new major versions of
+  Freeciv, until the relevant save format version can no longer be loaded.
+  If you really like to change a function name, be sure to keep also the
+  old one running.
 *****************************************************************************/
 
 $#ifdef HAVE_CONFIG_H

Modified: trunk/common/scriptcore/tolua_signal.pkg
URL: 
http://svn.gna.org/viewcvs/freeciv/trunk/common/scriptcore/tolua_signal.pkg?rev=33884&r1=33883&r2=33884&view=diff
==============================================================================
--- trunk/common/scriptcore/tolua_signal.pkg    (original)
+++ trunk/common/scriptcore/tolua_signal.pkg    Sun Sep 25 17:02:33 2016
@@ -13,9 +13,11 @@
 
 /*****************************************************************************
   ADVERTISEMENT: do not attempt to change the name of the API functions.
-  They *must* be compatible between the minor Freeciv versions within the
-  same major version. If you really like to change a function name, be sure
-  to keep also the old one running.
+  They may be in use in Lua scripts in savefiles, so once released, the
+  name and signature cannot change shape even in new major versions of
+  Freeciv, until the relevant save format version can no longer be loaded.
+  If you really like to change a function name, be sure to keep also the
+  old one running.
 *****************************************************************************/
 
 $#ifdef HAVE_CONFIG_H

Modified: trunk/server/scripting/tolua_server.pkg
URL: 
http://svn.gna.org/viewcvs/freeciv/trunk/server/scripting/tolua_server.pkg?rev=33884&r1=33883&r2=33884&view=diff
==============================================================================
--- trunk/server/scripting/tolua_server.pkg     (original)
+++ trunk/server/scripting/tolua_server.pkg     Sun Sep 25 17:02:33 2016
@@ -13,9 +13,11 @@
 
 /*****************************************************************************
   ADVERTISEMENT: do not attempt to change the name of the API functions.
-  They *must* be compatible between the minor Freeciv versions within the
-  same major version. If you really like to change a function name, be sure
-  to keep also the old one running.
+  They may be in use in Lua scripts in savefiles, so once released, the
+  name and signature cannot change shape even in new major versions of
+  Freeciv, until the relevant save format version can no longer be loaded.
+  If you really like to change a function name, be sure to keep also the
+  old one running.
 *****************************************************************************/
 
 $#ifdef HAVE_CONFIG_H


_______________________________________________
Freeciv-commits mailing list
Freeciv-commits@gna.org
https://mail.gna.org/listinfo/freeciv-commits

Reply via email to