* targhooks.c: Add comment explaining the migration process.

From-SVN: r71103

diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index 3db86c36a965ca638bfaf0fb8d31509fa9e1dc69..8ecc67dff6c78710120a78fabd1cc585e2fff3b9 100644 (file)
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,3 +1,7 @@
+2003-09-04  DJ Delorie  <dj@redhat.com>
+
+       * targhooks.c: Add comment explaining the migration process.
+
 2003-09-04  Eric Christopher  <echristo@redhat.com>
 
        * config/frv/t-frv: Fix path for frv-abi.h.

diff --git a/gcc/targhooks.c b/gcc/targhooks.c
index 7654e230b839bc054672abfdb47f58a2af60f5c6..97d0642540be16f7dacd8b3a66f005ebafa87567 100644 (file)
--- a/gcc/targhooks.c
+++ b/gcc/targhooks.c
@@ -18,6 +18,35 @@ along with GCC; see the file COPYING.  If not, write to the Free
 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 02111-1307, USA.  */
 
+/* The migration of target macros to target hooks works as follows:
+
+   1. Create a target hook that uses the existing target macros to
+      implement the same functionality.
+
+   2. Convert all the MI files to use the hook instead of the macro.
+
+   3. Repeat for a majority of the remaining target macros.  This will
+      take some time.
+
+   4. Tell target maintainers to start migrating.
+
+   5. Eventually convert the backends to override the hook instead of
+      defining the macros.  This will take some time too.
+
+   6. TBD when, poison the macros.  Unmigrated targets will break at
+      this point.
+
+   Note that we expect steps 1-3 to be done by the people that
+   understand what the MI does with each macro, and step 5 to be done
+   by the target maintainers for their respective targets.
+
+   Note that steps 1 and 2 don't have to be done together, but no
+   target can override the new hook until step 2 is complete for it.
+
+   Once the macros are poisoned, we will revert to the old migration
+   rules - migrate the macro, callers, and targets all at once.  This
+   comment can thus be removed at that point.  */
+
 #include "config.h"
 #include "system.h"
 #include "coretypes.h"