Commit Graph

330 Commits

Author SHA1 Message Date
Jaap Keuter 1fe8d892dd Update min. GLib version and add Qt version checks
The document describes why and how to version check, but
1) is not up to date with respect to minimum GLib version
2) does not yet mention Qt version requirement and check.
This change addresses both issues.

Change-Id: Ibb56c02cf48f6a4c6270b20686ca4d6e8aaf99d1
Reviewed-on: https://code.wireshark.org/review/14669
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Reviewed-by: Jaap Keuter <jaap.keuter@xs4all.nl>
2016-03-29 15:21:19 +00:00
João Valverde 11cd41d922 Add EditorConfig reference to README.developer
Change-Id: I595e94bd0274e3ee3c1d8764fc6c93f28993c30f
Reviewed-on: https://code.wireshark.org/review/14468
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Michael Mann <mmann78@netscape.net>
Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2016-03-14 22:44:43 +00:00
Guy Harris f9df9ffb3f Note that variadic macros *can* be sued.
Change-Id: I15bfda76256e5d1084ad7c64006f93afaf071a9e
Reviewed-on: https://code.wireshark.org/review/13010
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2016-01-02 23:18:49 +00:00
Guy Harris 11bdadacc2 Update to reflect current reality.
Change-Id: I98a104407feb21d038653e41c547c7ebc27771cb
Reviewed-on: https://code.wireshark.org/review/11636
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2015-11-08 10:00:00 +00:00
Peter Wu 6d7b29592a Allow use of variadic macros
Remove variadic macros restriction (c99, c++11 feature) from
README.developer. GCC, Clang, MSVC 2005 all support it.

Enable -Wno-variadic-macros in configure.ac and CMakeLists.txt when
-Wpedantic is enabled (which would enable -Wvariadic-macros).

For all files matching 'define\s*\w+[0-9]\(', replace "FOO[0-9]" by
"FOO" and adjust the macro definition accordingly. The nbap dissector
was regenerated after adjusting its template and .cnf file. The
generated code is the same since all files disabled the debug macros.

Discussed at:
https://www.wireshark.org/lists/wireshark-dev/201209/msg00142.html
https://www.wireshark.org/lists/wireshark-dev/201510/msg00012.html

Change-Id: I3b2e22487db817cbbaac774a592669a4f44314b2
Reviewed-on: https://code.wireshark.org/review/10781
Petri-Dish: Peter Wu <peter@lekensteyn.nl>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2015-10-05 07:57:14 +00:00
Pascal Quantin 33c26a09f4 doc: remove some references to the now defunct python support
Change-Id: Ibba3168516ef28ad050f5f70045acf3935f2b233
Reviewed-on: https://code.wireshark.org/review/5738
Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2014-12-12 21:25:00 +00:00
Gerald Combs 175039128a Update the doc directory to use https://www.wireshark.org.
Change-Id: I9bfc57cb6b6ab6962b80ff58d98eb351d6f69829
Reviewed-on: https://code.wireshark.org/review/4140
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-17 00:12:26 +00:00
Joerg Mayer 6a7414f726 README.dissector was split from README.developer in 2013 - update some
documents referring to the split out sections.
Remove trailing whitespace while at this.

Change-Id: I36cfe0ac55e8f653bffbf850e01f582aacf85557
Reviewed-on: https://code.wireshark.org/review/4094
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-09-13 05:34:39 +00:00
Jeff Morriss b6a9b8494c Remove $Id$ and other Subversion leftovers from the doc files.
Change-Id: I28a376f7e0fd90971f65ae9c1105a3ec85221470
Reviewed-on: https://code.wireshark.org/review/204
Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
2014-02-14 01:33:14 +00:00
Jakub Zawadzki 064082e68a Change G_GINT64_CONSTANT(xxxxU) to G_GUINT64_CONSTANT(xxxx)
svn path=/trunk/; revision=54314
2013-12-20 22:39:32 +00:00
Bill Meier 2a69c2d05c Remove a phrase which implies that tab widths other than 8 are OK.
svn path=/trunk/; revision=53030
2013-11-01 20:39:11 +00:00
Evan Huus e7a0c26bec Subsume README.binarytrees into wmem doxygen. The README was out of date
anyways, since Michael made key operations non-destructive in r44380.

svn path=/trunk/; revision=52583
2013-10-13 13:13:24 +00:00
Pascal Quantin a0c53ffaa1 emem -> wmem conversion:
- ep_tvb_get_bits() -> wmem_packet_tvb_get_bits()
- tvb_g_memdup()/ep_tvb_memdup() -> tvb_memdup()
- tvb_fake_unicode()/tvb_get_ephemeral_faked_unicode() -> tvb_get_faked_unicode()
- tvb_get_g_string()/tvb_get_ephemeral_string()/tvb_get_seasonal_string() -> tvb_get_string()
- tvb_get_g_unicode_string()/tvb_get_ephemeral_unicode_string() -> tvb_get_unicode_string()
- tvb_get_ephemeral_string_enc() -> tvb_get_string_enc()
- update docs accordingly

svn path=/trunk/; revision=52172
2013-09-22 15:50:55 +00:00
Gerald Combs b5e4fd5a01 Document the current state of naming in ui/qt. Say it's OK to use C++
comments in C++ code.

svn path=/trunk/; revision=51739
2013-09-03 18:50:17 +00:00
Evan Huus 602cf9cd4e Split README.developer into two: README.developer and README.dissector. All the
documentation specific to dissectors should now live in README.dissector - what
remains in README.developer should be useful to anybody coding on Wireshark
regardless of if you're working on the GUI, wiretap, dissectors, etc.

This first pass I did a fairly dumb split of copy-pasting relevant chunks from
one file to the other. There are probably fragments that aren't in the right
file anymore, so cleanup welcome.

svn path=/trunk/; revision=50092
2013-06-20 22:46:08 +00:00
Chris Maynard ab10fed503 Trivial: remove extraneous word, 'is'.
svn path=/trunk/; revision=49423
2013-05-20 01:35:17 +00:00
Evan Huus b39cf04f14 Add CppCheck to the list of things to run before submitting code for review.
svn path=/trunk/; revision=49077
2013-04-27 23:11:06 +00:00
Evan Huus 4e3c836273 Major cleanup of skeleton dissector and related bits of README.developer.
Changes of note:
- Removed the 'Copied from' notice, it's only relevant if they're *not* using
  the skeleton code. Added a paragraph to README.developer instead.
- Exorcised all references to if (tree) and placed them in their own section
  at the bottom as an optimization. Hopefully this will be less confusing.

svn path=/trunk/; revision=48861
2013-04-15 21:43:40 +00:00
Evan Huus bb2820deb0 Put the skeleton sample code from README.developer into its own file - it's
much easier to edit/maintain that way as well as much easier to copy for a
new dissector. Explicitly don't set the SVN id tag since this is a template.

svn path=/trunk/; revision=48860
2013-04-15 20:56:55 +00:00
Chris Maynard 07b35a96b7 Add some missing tvb_get_'s, proto_tree_add_'s, fix args and change all little_endian's to encoding. Some detailed descriptions are still missing though.
svn path=/trunk/; revision=48629
2013-03-28 20:22:47 +00:00
Evan Huus 8569907b9f From Steve Magnani via https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=8339
This patch adds a new public API, proto_tree_add_bitmask_len(), identical to
proto_tree_add_bitmask() but using a caller-supplied length rather than an
inferred one. The underlying proto_item_add_bitmask_tree() code is modified
to display only fields for which all defined bits are available, and to
ignore bits that have no corresponding defined field ("forward compatibility"
cases).

From me: minor edits, see the bug for more details.

svn path=/trunk/; revision=48049
2013-03-04 14:18:18 +00:00
Martin Kaiser 29de8baed5 mention gcrypt wrapper in README.developer
svn path=/trunk/; revision=47812
2013-02-21 22:24:43 +00:00
Alexis La Goutte ecb898db1e Fix the dev guide to use the correct indent (Tab => 4 Spaces) and add Modelines info
svn path=/trunk/; revision=47415
2013-02-01 09:22:40 +00:00
Chris Maynard 8ee3809edc Add 2 more verification steps to run in the "Submitting code for your new dissector" section.
svn path=/trunk/; revision=47388
2013-01-31 17:17:34 +00:00
Evan Huus a19980c23d Replace another instance of emem in README.developer with wmem.
svn path=/trunk/; revision=46847
2012-12-29 20:41:12 +00:00
Jeff Morriss 456acec892 Do a little more to discourage the use of proto_tree_add_text(): don't
use it as example in a few places and point out that if you're not using the
return value to build a subtree, you probably shouldn't be using the function.

svn path=/trunk/; revision=46617
2012-12-19 15:54:40 +00:00
Jeff Morriss ed87fa9e3b Come down harder on the evils of tvb_get_ptr(): advise not to use it.
Combine the two comments in the Portability section (which largely said the
same thing) on the perils of that function.

Don't suggest it as an option to ensure there are enough bytes in the TVB.

svn path=/trunk/; revision=46590
2012-12-18 16:42:16 +00:00
Evan Huus 7f23c2f8b7 Recommend wmem over emem in the READMEs where possible.
svn path=/trunk/; revision=46472
2012-12-08 21:57:05 +00:00
Jörg Mayer 015cdcef78 Fix the main dissect_PROTO signature
svn path=/trunk/; revision=46046
2012-11-16 20:52:30 +00:00
Jeff Morriss 22b7086fb9 We always HAVE_CONFIG_H so don't bother checking whether we have it or not.
svn path=/trunk/; revision=44997
2012-09-19 01:37:13 +00:00
Chris Maynard b840ba44b4 Trivial typo fix and duplicate word removal.
svn path=/trunk/; revision=44695
2012-08-29 17:05:38 +00:00
Bill Meier 0035a9076b Force extended value string linear search (not binary search) in one case:
Fixed: { -2, -1, 0, 1, 3} (note gap) used a binary search (which would fail);

 Note:  { -2, -1, 0, 1, 2 ,3 } (no gap) allowed; will still do a direct access;

Also: Add a comment to README.developer extended value string section.

svn path=/trunk/; revision=44659
2012-08-24 20:44:33 +00:00
Bill Meier 7d891022e6 Minor update to tcp_dissect_pdus() section.
svn path=/trunk/; revision=44658
2012-08-24 20:22:48 +00:00
Jörg Mayer 409f711889 Add a link where to find some GUIs for git.
svn path=/trunk/; revision=44554
2012-08-17 18:13:39 +00:00
Evan Huus 81f3e4f4a8 Add note to README.developer about not passing NULL to %s format strings.
Part of wireshark-dev conversation starting with:
http://www.wireshark.org/lists/wireshark-dev/201208/msg00125.html

svn path=/trunk/; revision=44548
2012-08-17 01:12:10 +00:00
Jeff Morriss 4fdc3c3cc2 Create, and start using, file name preferences.
File name preferences are basically just string preferences except that the
GUI will present a "Browse" button that allows the user to go and find the
file s/he wants (rather than having to blindly type in the full path).

svn path=/trunk/; revision=43228
2012-06-13 01:13:12 +00:00
Bill Meier 5b53b81835 Note that calls to "expert" functions should not be under 'if (tree)'.
svn path=/trunk/; revision=43224
2012-06-12 13:03:05 +00:00
Guy Harris 1c7269a6d1 Mention ENC_UCS_2 and ENC_UTF_16.
svn path=/trunk/; revision=42602
2012-05-12 20:10:18 +00:00
pascal c69d317daf Fix typo errors
svn path=/trunk/; revision=42340
2012-04-29 18:25:06 +00:00
pascal e94974887c Convert spaces to tabs
svn path=/trunk/; revision=42247
2012-04-25 21:37:10 +00:00
Bill Meier 7ee82aac06 Update descriptions of hf[] FIELDDISPLAY and BITMASK fields.
svn path=/trunk/; revision=41400
2012-03-07 16:38:08 +00:00
Bill Meier ae54957153 Emphasize corrext usage of FT_BOOLEAN 'display' field.
Specificaly:
 For a field type FT_BOOLEAN:
 - If the bitmask field is zero, then the 'display' field
   must be 'BASE_NONE';
 - If the bitmask field is non-zero, then the 'display' field
   must be the field-width of the parent bit field.

svn path=/trunk/; revision=41379
2012-03-06 20:51:50 +00:00
Bill Meier 24fc709aad (Trivial) Fix a typo.
svn path=/trunk/; revision=41343
2012-03-04 23:01:39 +00:00
Anders Broman d5851a0953 forgotten update
svn path=/trunk/; revision=41340
2012-03-04 19:03:03 +00:00
Anders Broman 872c2094c4 From Mike Morrin:
The attached patches add the uses
proto_tree_add_split_bits_ret_val()
proto_tree_add_split_bits_crumb()

https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=6885

svn path=/trunk/; revision=41249
2012-02-29 20:38:39 +00:00
Alexis La Goutte 5de89fbb74 Add tvb_ip_to_str and tvb_ip6_to_str to the Dev Guide
svn path=/trunk/; revision=40941
2012-02-09 17:41:22 +00:00
Chris Maynard c2eacb6f27 Fix some typos.
svn path=/trunk/; revision=40759
2012-01-29 15:51:21 +00:00
Chris Maynard 77e062c425 Mention the other integer accessors.
svn path=/trunk/; revision=40704
2012-01-24 20:31:35 +00:00
Jeff Morriss 3b0625c340 Fix a spelling mistake. Wrap a few long lines.
svn path=/trunk/; revision=39587
2011-10-26 01:42:55 +00:00
Bill Meier 024230ece0 Update information about 'encoding' arg values for particular field-types.
svn path=/trunk/; revision=39568
2011-10-25 17:27:48 +00:00