Add some information about how/why this dissector is (partially) machine-generated...
authormorriss <morriss@f5534014-38df-0310-8fa8-9805f1628bb7>
Tue, 27 Apr 2010 13:50:43 +0000 (13:50 +0000)
committermorriss <morriss@f5534014-38df-0310-8fa8-9805f1628bb7>
Tue, 27 Apr 2010 13:50:43 +0000 (13:50 +0000)
git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@32577 f5534014-38df-0310-8fa8-9805f1628bb7

plugins/opcua/README
plugins/opcua/opcua_complextypeparser.h
plugins/opcua/opcua_enumparser.h
plugins/opcua/opcua_hfindeces.h
plugins/opcua/opcua_identifiers.h
plugins/opcua/opcua_serviceids.h
plugins/opcua/opcua_serviceparser.h

index df58cd510865e82bf82c722b4ec610d3890a5744..07068d77d0dd36d1ba0276b10d1c9bfb7f657b42 100644 (file)
@@ -50,6 +50,37 @@ For more information see http://www.opcfoundation.org
 Known limitations:
 ==================
 
-* Only the security policy http://opcfoundation.org/UA/SecurityPolicy#None is supported,
-  which means the encryption and signing is turned off.
+* Only the security policy http://opcfoundation.org/UA/SecurityPolicy#None is
+  supported, which means the encryption and signing is turned off.
   
+Machine-generated dissector:
+============================
+Parts of the OpcUa dissector are machine generated.  Several of the files are
+marked "DON'T MODIFY THIS FILE!" for this reason.
+
+However, the code to create this dissector is not part of the Wireshark source
+source code distribution.  This was discussed prior to the plugin's inclusion.
+From http://www.wireshark.org/lists/wireshark-dev/200704/msg00025.html :
+
+~~~
+> a lot of the code seems to be autogenerated (as the comments suggest)
+> It might make sense to include the sources and the build process instead 
+> of the intermediate files (if the amount of code/tools to build the 
+> files seems reasonable). The reason: When people start to hack your code 
+> (e.g. to remove warnings on a compiler you don't even think about), 
+> you'll might get into annoying trouble with merging code the next time 
+> you've update the upcua files.
+>
+>   
+I'm sorry, but I cannot give you the sources of the code generator,
+because they are owned by the OPC Foundation.
+I only extended the existing code generator to produce also wireshark code.
+It's .Net based so I guess you don't want to have it anyway ;-)
+~~~
+
+So, if changes must be made to the machine-generated files, it just means the
+upstream source will have to be modified before pushing any updates back to
+Wireshark.
+
+Of course it also means that care must be taken when applying patches from
+upstream to ensure local changes aren't reversed.
index 502542a3cef5c004ad42d54a45f854a322715ca4..e34965a47e9455c32f88413c656abe8ac089b2ac 100644 (file)
@@ -3,21 +3,22 @@
 **
 ** Copyright (C) 2006-2009 ascolab GmbH. All Rights Reserved.
 ** Web: http://www.ascolab.com
-** 
+**
 ** This program is free software; you can redistribute it and/or
 ** modify it under the terms of the GNU General Public License
 ** as published by the Free Software Foundation; either version 2
 ** of the License, or (at your option) any later version.
-** 
+**
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-** 
+**
 ** Project: OpcUa Wireshark Plugin
 **
 ** Description: OpcUa Complex Type Parser
 **
 ** This file was autogenerated on 31.03.2009.
 ** DON'T MODIFY THIS FILE!
+** XXX - well, except that you may have to.  See the README.
 **
 ******************************************************************************/
 
index 1778c79f6a8d8565433284b7ae5f1f12a5b938ba..b82c5a98f87e42079b9e5decb08344742c61e529 100644 (file)
@@ -3,21 +3,22 @@
 **
 ** Copyright (C) 2006-2009 ascolab GmbH. All Rights Reserved.
 ** Web: http://www.ascolab.com
-** 
+**
 ** This program is free software; you can redistribute it and/or
 ** modify it under the terms of the GNU General Public License
 ** as published by the Free Software Foundation; either version 2
 ** of the License, or (at your option) any later version.
-** 
+**
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-** 
+**
 ** Project: OpcUa Wireshark Plugin
 **
 ** Description: OpcUa Enum Type Parser
 **
 ** This file was autogenerated on 31.03.2009.
 ** DON'T MODIFY THIS FILE!
+** XXX - well, except that you may have to.  See the README.
 **
 ******************************************************************************/
 
index 2117b84512770b8baff2cf080617f1acb3bee584..44cd27a0f540895563d18d03b54359451785b38b 100644 (file)
@@ -3,21 +3,22 @@
 **
 ** Copyright (C) 2006-2009 ascolab GmbH. All Rights Reserved.
 ** Web: http://www.ascolab.com
-** 
+**
 ** This program is free software; you can redistribute it and/or
 ** modify it under the terms of the GNU General Public License
 ** as published by the Free Software Foundation; either version 2
 ** of the License, or (at your option) any later version.
-** 
+**
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-** 
+**
 ** Project: OpcUa Wireshark Plugin
 **
 ** Description: This file contains protocol field handles.
 **
 ** This file was autogenerated on 31.03.2009.
 ** DON'T MODIFY THIS FILE!
+** XXX - well, except that you may have to.  See the README.
 **
 ******************************************************************************/
 
index e0288c5d1153f640ad405a9bd7a4c025e0bc51d5..e817612b7c725447e51bf33bd4d0bf4c6b97fc1f 100644 (file)
@@ -3,21 +3,22 @@
 **
 ** Copyright (C) 2006-2007 ascolab GmbH. All Rights Reserved.
 ** Web: http://www.ascolab.com
-** 
+**
 ** This program is free software; you can redistribute it and/or
 ** modify it under the terms of the GNU General Public License
 ** as published by the Free Software Foundation; either version 2
 ** of the License, or (at your option) any later version.
-** 
+**
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-** 
+**
 ** Project: OpcUa Wireshark Plugin
 **
 ** Description: Parser type definitions.
 **
 ** This file was autogenerated on 6/10/2007 2:35:22 AM.
 ** DON'T MODIFY THIS FILE!
+** XXX - well, except that you may have to.  See the README.
 **
 ******************************************************************************/
 
index 7c55f464cd104bf0c034b63caf5f979d616d40e5..79bda0a6ceb0444ae759bee9df662b9f2df89e03 100644 (file)
@@ -3,21 +3,22 @@
 **
 ** Copyright (C) 2006-2009 ascolab GmbH. All Rights Reserved.
 ** Web: http://www.ascolab.com
-** 
+**
 ** This program is free software; you can redistribute it and/or
 ** modify it under the terms of the GNU General Public License
 ** as published by the Free Software Foundation; either version 2
 ** of the License, or (at your option) any later version.
-** 
+**
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-** 
+**
 ** Project: OpcUa Wireshark Plugin
 **
 ** Description: OpcUa Service IDs
 **
 ** This file was autogenerated on 31.03.2009.
 ** DON'T MODIFY THIS FILE!
+** XXX - well, except that you may have to.  See the README.
 **
 ******************************************************************************/
 
index fd2b236797a3543d6d93ceddfbcb663ad683274d..b674ebf28416cf1074b371ceff117023bbbcf23b 100644 (file)
@@ -3,21 +3,22 @@
 **
 ** Copyright (C) 2006-2009 ascolab GmbH. All Rights Reserved.
 ** Web: http://www.ascolab.com
-** 
+**
 ** This program is free software; you can redistribute it and/or
 ** modify it under the terms of the GNU General Public License
 ** as published by the Free Software Foundation; either version 2
 ** of the License, or (at your option) any later version.
-** 
+**
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-** 
+**
 ** Project: OpcUa Wireshark Plugin
 **
 ** Description: OpcUa Service Type Parser
 **
 ** This file was autogenerated on 31.03.2009.
 ** DON'T MODIFY THIS FILE!
+** XXX - well, except that you may have to.  See the README.
 **
 ******************************************************************************/