[Bf-blender-cvs] [a3b3b9d74ba] master: DNA: comment on how to avoid DNA rename errors

[Campbell Barton]

Commit: a3b3b9d74ba258a6bbbafab989615fc21ec0037b
Author: Campbell Barton
Date:   Sun Feb 17 19:10:34 2019 +1100
Branches: master
https://developer.blender.org/rBa3b3b9d74ba258a6bbbafab989615fc21ec0037b

DNA: comment on how to avoid DNA rename errors

===================================================================

M	source/blender/makesdna/intern/dna_rename_defs.h

===================================================================

diff --git a/source/blender/makesdna/intern/dna_rename_defs.h b/source/blender/makesdna/intern/dna_rename_defs.h
index 0b21fb8420b..63a6da32ae6 100644
--- a/source/blender/makesdna/intern/dna_rename_defs.h
+++ b/source/blender/makesdna/intern/dna_rename_defs.h
@@ -36,6 +36,13 @@
  * - Old names aren't sanity checked (since this file is the only place that knows about them)
  *   typos in the old names will break both backwards & forwards compatibility **TAKE CARE**.
  *
+ * - Before editing rename defines run:
+ *
+ *   `sha1sum $BUILD_DIR/source/blender/makesdna/intern/dna.c`
+ *
+ *   Compare the results before & after to ensure all changes are reversed by renaming
+ *   and the DNA remains unchanged.
+ *
  * \see versioning_dna.c for a actual version patching.
  */