Add an item about prefixing #define names and enum names with a prefix

to avoid name collisions.


git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@8649 f5534014-38df-0310-8fa8-9805f1628bb7

1 files changed, 8 insertions, 3 deletions

diff --git a/doc/README.developer b/doc/README.developer
index d78bf47e5b..9ff632c220 100644
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -1,4 +1,4 @@
-$Id: README.developer,v 1.79 2003/10/06 19:11:41 guy Exp $
+$Id: README.developer,v 1.80 2003/10/09 18:57:37 guy Exp $
 
 This file is a HOWTO for Ethereal developers. It describes how to start coding
 a Ethereal protocol dissector and the use some of the important functions and
@@ -189,6 +189,11 @@ as some compilers will reject the first of those statements.  Instead,
 initialize the array at the point at which it's first declared, so that
 the size is known.
 
+For #define names and enum member names, prefix the names with a tag so
+as to avoid collisions with other names - this might be more of an issue
+on Windows, as it appears to #define names such as DELETE and
+OPTIONAL.
+
 1.1.2 Name convention.
 
 Ethereal uses the underscore_convention rather than the InterCapConvention for
@@ -226,7 +231,7 @@ code inside
 
 is needed only if you are using the "snprintf()" function.
 
-The "$Id: README.developer,v 1.79 2003/10/06 19:11:41 guy Exp $"
+The "$Id: README.developer,v 1.80 2003/10/09 18:57:37 guy Exp $"
 in the comment will be updated by CVS when the file is
 checked in; it will allow the RCS "ident" command to report which
 version of the file is currently checked out.
@@ -236,7 +241,7 @@ version of the file is currently checked out.
  * Routines for PROTONAME dissection
  * Copyright 2000, YOUR_NAME <YOUR_EMAIL_ADDRESS>
  *
- * $Id: README.developer,v 1.79 2003/10/06 19:11:41 guy Exp $
+ * $Id: README.developer,v 1.80 2003/10/09 18:57:37 guy Exp $
  *
  * Ethereal - Network traffic analyzer
  * By Gerald Combs <gerald@ethereal.com>