Revision: 41072
http://brlcad.svn.sourceforge.net/brlcad/?rev=41072&view=rev
Author: brlcad
Date: 2010-10-19 03:43:52 +0000 (Tue, 19 Oct 2010)
Log Message:
-----------
move the minimally impacting docs down with that section in order to keep them
in localized context. add bu_ptbl() changes.
Modified Paths:
--------------
brlcad/trunk/doc/deprecation.txt
Modified: brlcad/trunk/doc/deprecation.txt
===================================================================
--- brlcad/trunk/doc/deprecation.txt 2010-10-19 02:18:28 UTC (rev 41071)
+++ brlcad/trunk/doc/deprecation.txt 2010-10-19 03:43:52 UTC (rev 41072)
@@ -9,8 +9,8 @@
interface (CLI) and graphical user interface (GUI) behaviors.
The general practice is that public interface changes may go from
-deprecated to obsolete, whereby previous published behavior is removed
-or changed, during one of the following events:
+deprecated to obsolete, whereby previous behavior is removed or
+changed, during one of the following events:
a) during a major release (e.g. going from 7.*.* to 8.*.*)
@@ -21,7 +21,7 @@
c) during a minor release provided there still exists an equivalent
alternative interface that will not impose an undue burden on users
- or developers (see "Minimally Impacting")
+ or developers (see "MINIMALLY IMPACTING API CHANGES" below)
d) during a patch release provided you can correctly prove P = NP
@@ -31,15 +31,6 @@
not part of publicly available documentation are fair game to change
as needed.
-Minimally Impacting: If a change to an interface has a suitable and
-completely equivalent alternative, the change is deemed to be
-"minimally impacting" and can be made during any minor release.
-Examples of such changes include renaming an interface, reordering
-parameters, adding new parameters to an interface for previously
-implicit or restricted behavior, and removing unused parameters.
-Basically, the impact can usually be considered minor if a simple
-regular expression search-and-replace is all that is needed.
-
Where feasible, interfaces should be visibly marked as deprecated
either during compile-time with #warning pre-processor declarations or
during run-time with print statements.
@@ -278,7 +269,33 @@
***********************************
* MINIMALLY IMPACTING API CHANGES *
***********************************
+
+If a change to an interface has a suitable and completely equivalent
+alternative, the change is deemed to be "minimally impacting" and can
+be made during any minor release. Examples of such changes include
+renaming an interface, reordering parameters, adding new parameters to
+an interface for previously implicit or restricted behavior, and
+removing unused parameters.
+
+Basically, the impact can usually be considered minor if a static
+regular expression search-and-replace is all that is needed to update.
+Included in following are various minimally impacting API changes that
+have been identified in reverse chronological order. As expressions
+are not extensively tested, use with caution.
+
+s/bu_ptbl(\([^,]*\),[[:space:]]*BU_PTBL_INIT\([^)]*\))/bu_ptbl_init(\1, 64,
"init")/g
+s/bu_ptbl(\([^,]*\),[[:space:]]*BU_PTBL_RST\([^)]*\))/bu_ptbl_reset(\1)/g
+s/bu_ptbl(\([^,]*\),[[:space:]]*BU_PTBL_INS\([^)]*\))/bu_ptbl_ins(\1\2)/g
+s/bu_ptbl(\([^,]*\),[[:space:]]*BU_PTBL_LOC\([^)]*\))/bu_ptbl_locate(\1\2)/g
+s/bu_ptbl(\([^,]*\),[[:space:]]*BU_PTBL_ZERO\([^)]*\))/bu_ptbl_zero(\1\2/g
+s/bu_ptbl(\([^,]*\),[[:space:]]*BU_PTBL_INS_UNIQUE\([^)]*\))/bu_ptbl_ins_unique(\1\2)/g
+s/bu_ptbl(\([^,]*\),[[:space:]]*BU_PTBL_RM\([^)]*\))/bu_ptbl_rm(\1\2)/g
+s/bu_ptbl(\([^,]*\),[[:space:]]*BU_PTBL_CAT\([^)]*\))/bu_ptbl_cat(\1\2)/g
+s/bu_ptbl(\([^,]*\),[[:space:]]*BU_PTBL_FREE\([^)]*\))/bu_ptbl_free(\1)/g
+ bu_ptbl() removed [7.18]
+
s/rt_ptalloc();/(struct rt_pt_node *)bu_malloc(sizeof(struct rt_pt_node),
"rt_pt_node");/g
- rt_ptalloc_removed [7.16]
+ rt_ptalloc() removed [7.16]
+
s/rt_db_free_internal(\([^,]+\),[^)]*)/rt_db_free_internal(\1)/g
struct resource pointer parameter removed [7.14]
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Download new Adobe(R) Flash(R) Builder(TM) 4
The new Adobe(R) Flex(R) 4 and Flash(R) Builder(TM) 4 (formerly
Flex(R) Builder(TM)) enable the development of rich applications that run
across multiple browsers and platforms. Download your free trials today!
http://p.sf.net/sfu/adobe-dev2dev
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
