guile/guile-core HACKING

[Marius Vollmer]

CVSROOT:        /cvs
Module name:    guile
Changes by:     Marius Vollmer <address@hidden> 01/05/02 15:55:33

Modified files:
        guile-core     : HACKING 

Log message:
        Updated section about deprecating features.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/HACKING.diff?cvsroot=OldCVS&tr1=1.42&tr2=1.43&r1=text&r2=text

Patches:
Index: guile/guile-core/HACKING
diff -u guile/guile-core/HACKING:1.42 guile/guile-core/HACKING:1.43
--- guile/guile-core/HACKING:1.42       Wed Feb 21 14:51:23 2001
+++ guile/guile-core/HACKING    Wed May  2 15:55:33 2001
@@ -185,18 +185,28 @@
 
 1. Mark the definition using
 
-#if (SCM_DEBUG_DEPRECATED == 0)
-...
-#endif
-
-2. Write a comment at the definition explaining how a programmer
-can manage without the deprecated definition.
-
-3. Add an entry that the definition has been deprecated in NEWS
-
-4. At the top of RELEASE, there is a list of releases with reminders
-about what to do at each release.  Add a reminder about the removal of
-the deprecated defintion at the appropriate release.
+   #if (SCM_DEBUG_DEPRECATED == 0)
+   ...
+   #endif
+
+   or, for Scheme code, wrap it using
+
+   (begin-deprecated
+      ...)
+
+2. Make the deprecated code issue a warning when it is used, by using
+   scm_c_issue_deprecation_warning (in C) or issue-deprecation-warning
+   (in Scheme).
+
+3. Write a comment at the definition explaining how a programmer can
+   manage without the deprecated definition.
+
+4. Add an entry that the definition has been deprecated in NEWS and
+   explain what do do instead.
+
+5. At the top of RELEASE, there is a list of releases with reminders
+   about what to do at each release.  Add a reminder about the removal
+   of the deprecated defintion at the appropriate release.
 
 - When you make a user-visible change (i.e. one that should be
 documented, and appear in NEWS, put an asterisk in column zero of the