changeset 6248:2f53d41ae71f

Upgrading directions from 2.0.0 - classname format requirements.
author John Rouillard <rouilj@ieee.org>
date Tue, 28 Jul 2020 21:41:59 -0400
parents ca0915457761
children 3b62c35e824d
files doc/upgrading.txt
diffstat 1 files changed, 18 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/upgrading.txt	Tue Jul 28 20:58:04 2020 -0400
+++ b/doc/upgrading.txt	Tue Jul 28 21:41:59 2020 -0400
@@ -22,6 +22,24 @@
 .. contents::
    :local:
 
+.. index:: Upgrading; 1.6.x to 2.x.x
+
+Migrating from 2.0.0 to 2.x.x
+=============================
+
+Classname Format Enforced
+=========================
+
+Check schema.py and look at all Class(), IssueClass(), FileClass()
+calls. The second argument is the classname. All classnames must:
+
+   * start with an alphabetic character
+   * consist of alphanumerics and '_'
+   * not end with a digit
+
+this was not enforced before. Using non-standard classnames could lead
+to other issues.
+
 .. index:: Upgrading; 1.6.x to 2.0.0
 
 Migrating from 1.6.X to 2.0.0

Roundup Issue Tracker: http://roundup-tracker.org/