From 7bd6bae799a46381cd572e46f0a7b9979fd0b6eb Mon Sep 17 00:00:00 2001 From: Graham Bloice Date: Thu, 25 Feb 2016 18:55:39 +0000 Subject: Update README.plugins to remove deprecated nmake references Change-Id: I259fe24e6dca7679f22492161b0c4cd97c7521de Reviewed-on: https://code.wireshark.org/review/14145 Reviewed-by: Graham Bloice --- doc/README.plugins | 73 ++++++++++++------------------------------------------ 1 file changed, 16 insertions(+), 57 deletions(-) (limited to 'doc/README.plugins') diff --git a/doc/README.plugins b/doc/README.plugins index ca4a1d2281..78744cc580 100644 --- a/doc/README.plugins +++ b/doc/README.plugins @@ -23,10 +23,9 @@ ChangeLog CMakeLists.txt Makefile.am Makefile.common -Makefile.nmake moduleinfo.h -moduleinfo.nmake plugin.rc.in + And of course the source and header files for your dissector. Examples of these files can be found in plugins/gryphon. @@ -58,22 +57,12 @@ The header files for your dissector, if any, must be listed in the DISSECTOR_INCLUDES variable. The DISSECTOR_INCLUDES variable should not include moduleinfo.h. -2.5 Makefile.nmake - -For your plugins/foo/Makefile.nmake file, see the corresponding file in -plugins/gryphon. No modifications are needed here. - -2.6 moduleinfo.h +2.5 moduleinfo.h Your plugins/foo/moduleinfo.h file is used to set the version information for the plugin. -2.7 moduleinfo.nmake - -Your plugins/foo/moduleinfo.nmake is used to set the version information -for building the plugin. Its contents should match that in moduleinfo.h - -2.8 plugin.rc.in +2.6 plugin.rc.in Your plugins/foo/plugin.rc.in is the Windows resource template file used to add the plugin specific information as resources to the DLL. @@ -88,8 +77,9 @@ your goal. Setting up the permanent addition is somewhat more involved. 3.1 Custom extension -Go to the plugins directory and copy the three Custom.*.example files to -Custom.*. Now you have three files ready for building a plugin with the +Go to the plugins directory and copy the Custom.m4.example and +Custom.make.example files to files of the same name but without the ".example" +suffix. Now you have two Custom files ready for building a plugin with the name "foo". Replace the name if you so require. If you want to add the plugin to your own Windows installer add a text @@ -98,12 +88,6 @@ file named custom_plugins.txt to the packaging/nsis directory, with a File "..\..\plugins\foo\foo.dll" -Then open packaging/nsis/Custom.nmake and add the relative path to your -DLL to CUSTOM_PLUGINS: - -CUSTOM_PLUGINS= \ - ../../plugins/foo/foo.dll - For CMake builds, either pass the custom plugin dir on the CMake generation step command line: @@ -111,13 +95,13 @@ CMake ... -DCUSTOM_PLUGIN_SRC_DIR="plugins/foo" or copy the top-level file CMakeListsCustom.txt.example to CMakeListsCustom.txt (also in the top-level source dir) and edit so that CUSTOM_PLUGIN_SRC_DIR is -set() to the releative path of your plugin, e.g. +set() to the relative path of your plugin, e.g. set(CUSTOM_PLUGIN_SRC_DIR plugins/foo) and re-run the CMake generation step. -To build the plugin run your normal Wireshark build step. +To build the plugin, run your normal Wireshark build step. 3.2 Permanent addition @@ -127,10 +111,8 @@ You will need to change the following files: CMakeLists.txt epan/Makefile.am Makefile.am - packaging/nsis/Makefile.nmake packaging/nsis/wireshark.nsi plugins/Makefile.am - plugins/Makefile.nmake You might also want to search your Wireshark development directory for occurrences of an existing plugin name, in case this document is out of @@ -153,19 +135,7 @@ SUBDIRS = $(_CUSTOM_SUBDIRS_) \ irda \ -3.2.2 Changes to plugins/Makefile.nmake - -In plugins/Makefile.nmake you need to add to PLUGINS_LIST (in alphabetical -order) the name of your plugin: - -PLUGIN_LIST = \ - ... - ethercat \ - foo \ - gryphon \ - irda \ - -3.2.3 Changes to the top level Makefile.am +3.2.2 Changes to the top level Makefile.am Add your plugin (in alphabetical order) to plugin_ldadd: @@ -179,7 +149,7 @@ plugin_ldadd = $(_CUSTOM_plugin_ldadd_) \ -dlopen plugins/irda/irda.la \ ... -3.2.4 Changes to the top level configure.ac +3.2.3 Changes to the top level configure.ac You need to add your plugins Makefile (in alphbetical order) to the AC_OUTPUT rule in the configure.ac @@ -193,7 +163,7 @@ AC_OUTPUT( ... ,) -3.2.5 Changes to epan/Makefile.am +3.2.4 Changes to epan/Makefile.am Add the relative path of all your plugin source files (in alphbetical order) to plugin_src: @@ -208,7 +178,7 @@ plugin_src = \ ../plugins/irda/packet-irda.c \ ... -3.2.6 Changes to CMakeLists.txt +3.2.5 Changes to CMakeLists.txt Add your plugin (in alphabetical order) to the PLUGIN_SRC_DIRS: @@ -222,23 +192,12 @@ if(ENABLE_PLUGINS) plugins/irda ... -3.2.7 Changes to the installers +3.2.6 Changes to the installers If you want to include your plugin in an installer you have to add lines -in the NSIS installer Makefile.nmake and wireshark.nsi files. - -3.2.7.1 Changes to packaging/nsis/Makefile.nmake - -Add the relative path of your plugin DLL (in alphbetical order) to PLUGINS: - -PLUGINS= \ - ... - ../../plugins/ethercat/ethercat.dll \ - ../../plugins/foo/foo.dll \ - ../../plugins/gryphon/gryphon.dll \ - ../../plugins/irda/irda.dll \ +in the NSIS installer wireshark.nsi file. -3.2.7.2 Changes to packaging/nsis/wireshark.nsi +3.2.6.1 Changes to packaging/nsis/wireshark.nsi Add the relative path of your plugin DLL (in alphbetical order) to the list of "File" statements in the "Dissector Plugins" section: @@ -248,7 +207,7 @@ File "${STAGING_DIR}\plugins\${VERSION}\foo.dll" File "${STAGING_DIR}\plugins\${VERSION}\gryphon.dll" File "${STAGING_DIR}\plugins\${VERSION}\irda.dll" -3.2.7.3 Other installers +3.2.6.2 Other installers The PortableApps installer copies plugins from the build directory and should not require configuration. -- cgit v1.2.1