Difference between revisions of "Deprecating a Token"
 (→Steps)  | 
				|||
| Line 15: | Line 15: | ||
pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java  | pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java  | ||
# Edit the deprecated token e.g. Like [http://pcgen.svn.sourceforge.net/viewvc/pcgen/branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java?r1=7022&r2=7017&pathrev=7022 this].  | # Edit the deprecated token e.g. Like [http://pcgen.svn.sourceforge.net/viewvc/pcgen/branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java?r1=7022&r2=7017&pathrev=7022 this].  | ||
| − | # Open a Doc   | + | # Open a Doc Issue to set that token to be deprecated.  | 
| − | # Open Data   | + | # Open Data Issue so that people convert from the old token to the new token.  | 
| − | # Open a PrettyLst   | + | # Open a PrettyLst Issue so that the token can be put into the correct area for warnings etc.  | 
Revision as of 09:59, 27 April 2010
Contents | 
Introduction
We have a formal method around removing tokens, the first step being to deprecate them for the next major release cycle. e.g. If the current PCGen version is 5.14.2 then we can deprecate a token for the 5.16.x line and perform the actual removal in the 6.0.x line.
Steps
- Move the token in the build script so that it is built in the deprecated tokens area, e.g. example
 - SVN Move the java source file, e.g. 
 
FROM 
 
branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/template/BonusfeatsToken.java 
TO 
pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java
- Edit the deprecated token e.g. Like this.
 - Open a Doc Issue to set that token to be deprecated.
 - Open Data Issue so that people convert from the old token to the new token.
 - Open a PrettyLst Issue so that the token can be put into the correct area for warnings etc.