diff options
| author | Bill Meier <wmeier@newsguy.com> | 2008-05-21 14:27:31 +0000 |
|---|---|---|
| committer | Bill Meier <wmeier@newsguy.com> | 2008-05-21 14:27:31 +0000 |
| commit | cfeb34f62b33e61b3b41f1749c7d90f878602a51 (patch) | |
| tree | 159bd23dccda6ae4dcfacc3d80d27ffd0e5b2e85 /doc | |
| parent | a2ab3791f4283f914b1500b38f42bf25052ffa7e (diff) | |
Only Glib/GTK+ >= 2.4/2.4 supported; checkAPIs.pl should be used to verify code.
svn path=/trunk/; revision=25340
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.developer | 21 |
1 files changed, 8 insertions, 13 deletions
diff --git a/doc/README.developer b/doc/README.developer index 59b9348b22..0bd8faef24 100644 --- a/doc/README.developer +++ b/doc/README.developer @@ -373,19 +373,10 @@ cause a trap, which will, at best, result in the OS slowly performing an unaligned access for you, and will, on at least some platforms, cause the program to be terminated. -Wireshark supports both platforms with GLib 1.2[.x]/GTK+ 1.2[.x] and GLib -2.x/GTK+ 1.3[.x] and 2.x. If at all possible, either use only -mechanisms that are present in GLib 1.2[.x] and GTK+ 1.2[.x], use #if's -to conditionally use older or newer mechanisms depending on the platform -on which Wireshark is being built, or, if the code in GLib or GTK+ that -implements that mechanism will build with GLib 1.2[.x]/GTK+ 1.2[.x], -conditionally include that code as part of the Wireshark source and use -the included version with GLib 1.2[.x] or GTK+ 1.2[.x]. In particular, -if the GLib 2.x or GTK+ 2.x mechanism indicates that a routine is -deprecated and shouldn't be used in new code, and that it was renamed in -GLib 2.x or GTK+ 2.x and the new name should be used, disregard that and -use the old name - it'll still work with GLib 2.x or GTK+ 2.x, but will -also work with GLib 1.2[.x] and GTK+ 1.2[.x]. +Wireshark supports platforms with GLib 2.4[.x]/GTK+ 2.4[.x] or newer. +If a Glib/GTK+ mechanism is available only in Glib/GTK+ versions +newer than 2.4/2.4 then use "#if GTK_CHECK_VERSION(...)" to conditionally +compile code using that mechanism. When different code must be used on UN*X and Win32, use a #if or #ifdef that tests _WIN32, not WIN32. Try to write code portably whenever @@ -2609,6 +2600,10 @@ compile). 1.11 Submitting code for your new dissector. + - VERIFY that your dissecor code does not use prohibited or deprecated APIs + as follows: + perl <wireshark_root>/tools/checkAPIs.pl <source-filename(s)> + - TEST YOUR DISSECTOR BEFORE SUBMITTING IT. Use fuzz-test.sh and/or randpkt against your dissector. These are described at <http://wiki.wireshark.org/FuzzTesting>. |