ITK Release 4/MigrationGuideDeveloperTutorial

General Steps

This tutorial provides a quick walkthrough of how to document changes made to the API during the ITKv4 development process. The steps of this guide only need to be followed when making an API change. The process consists of creating an XML document in the $ITK_SOURCE_DIR/Migration folder that represents the changes made to the API and including this document in the patch that gets reviewed in Gerrit.

Step 1 - Make the Change

• Start a new topic branch for the desired change
  • This topic branch should only be used to make the desired API change (it should not combine multiple change topics)
  • Give the branch a descriptive name that corresponds to the nature of the API change
  • The topic branch name should correspond to the name for the XML document
• Make the API changes locally
• Commit the changes
  • The changes must be committed prior to using the automatic XML initialization tool
  • Make sure to use descriptive commit messages for all commits since they will be used by the automatic tool when initializing the XML document

Step 2 - Create the XML Document

• Follow the steps in either the Manual Instructions or the Automatic Instructions to create an XML document for the API change.
• XML documents from all API changes will in $ITK_SOURCE_DIR/Migration
• Once written, commit the XML document to the local topic branch

==Step 3 -