aboutsummaryrefslogtreecommitdiffstats
path: root/doc/README.developer
AgeCommit message (Collapse)AuthorFilesLines
2013-06-20Split README.developer into two: README.developer and README.dissector. All theEvan Huus1-3131/+16
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-05-20Trivial: remove extraneous word, 'is'.Chris Maynard1-1/+1
svn path=/trunk/; revision=49423
2013-04-27Add CppCheck to the list of things to run before submitting code for review.Evan Huus1-0/+5
svn path=/trunk/; revision=49077
2013-04-15Major cleanup of skeleton dissector and related bits of README.developer.Evan Huus1-8/+42
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-15Put the skeleton sample code from README.developer into its own file - it'sEvan Huus1-369/+20
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-03-28Add some missing tvb_get_'s, proto_tree_add_'s, fix args and change all ↵Chris Maynard1-82/+110
little_endian's to encoding. Some detailed descriptions are still missing though. svn path=/trunk/; revision=48629
2013-03-04From Steve Magnani via https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=8339Evan Huus1-9/+34
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-02-21mention gcrypt wrapper in README.developerMartin Kaiser1-0/+5
svn path=/trunk/; revision=47812
2013-02-01Fix the dev guide to use the correct indent (Tab => 4 Spaces) and add ↵Alexis La Goutte1-966/+977
Modelines info svn path=/trunk/; revision=47415
2013-01-31Add 2 more verification steps to run in the "Submitting code for your new ↵Chris Maynard1-0/+8
dissector" section. svn path=/trunk/; revision=47388
2012-12-29Replace another instance of emem in README.developer with wmem.Evan Huus1-3/+3
svn path=/trunk/; revision=46847
2012-12-19Do a little more to discourage the use of proto_tree_add_text(): don'tJeff Morriss1-7/+9
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-18Come down harder on the evils of tvb_get_ptr(): advise not to use it.Jeff Morriss1-43/+28
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-08Recommend wmem over emem in the READMEs where possible.Evan Huus1-17/+17
svn path=/trunk/; revision=46472
2012-11-16Fix the main dissect_PROTO signatureJörg Mayer1-1/+1
svn path=/trunk/; revision=46046
2012-09-19We always HAVE_CONFIG_H so don't bother checking whether we have it or not.Jeff Morriss1-3/+1
svn path=/trunk/; revision=44997
2012-08-29Trivial typo fix and duplicate word removal.Chris Maynard1-2/+2
svn path=/trunk/; revision=44695
2012-08-24Force extended value string linear search (not binary search) in one case:Bill Meier1-2/+10
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-24Minor update to tcp_dissect_pdus() section.Bill Meier1-3/+4
svn path=/trunk/; revision=44658
2012-08-17Add a link where to find some GUIs for git.Jörg Mayer1-0/+2
svn path=/trunk/; revision=44554
2012-08-17Add note to README.developer about not passing NULL to %s format strings.Evan Huus1-0/+4
Part of wireshark-dev conversation starting with: http://www.wireshark.org/lists/wireshark-dev/201208/msg00125.html svn path=/trunk/; revision=44548
2012-06-13Create, and start using, file name preferences.Jeff Morriss1-0/+8
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-12Note that calls to "expert" functions should not be under 'if (tree)'.Bill Meier1-14/+16
svn path=/trunk/; revision=43224
2012-05-12Mention ENC_UCS_2 and ENC_UTF_16.Guy Harris1-5/+11
svn path=/trunk/; revision=42602
2012-04-29Fix typo errorspascal1-2/+2
svn path=/trunk/; revision=42340
2012-04-25Convert spaces to tabspascal1-6/+6
svn path=/trunk/; revision=42247
2012-03-07Update descriptions of hf[] FIELDDISPLAY and BITMASK fields.Bill Meier1-2/+4
svn path=/trunk/; revision=41400
2012-03-06Emphasize corrext usage of FT_BOOLEAN 'display' field.Bill Meier1-14/+20
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-04(Trivial) Fix a typo.Bill Meier1-1/+1
svn path=/trunk/; revision=41343
2012-03-04forgotten updateAnders Broman1-2/+2
svn path=/trunk/; revision=41340
2012-02-29From Mike Morrin:Anders Broman1-0/+18
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-09Add tvb_ip_to_str and tvb_ip6_to_str to the Dev GuideAlexis La Goutte1-0/+6
svn path=/trunk/; revision=40941
2012-01-29Fix some typos.Chris Maynard1-12/+12
svn path=/trunk/; revision=40759
2012-01-24Mention the other integer accessors.Chris Maynard1-3/+4
svn path=/trunk/; revision=40704
2011-10-26Fix a spelling mistake. Wrap a few long lines.Jeff Morriss1-13/+14
svn path=/trunk/; revision=39587
2011-10-25Update information about 'encoding' arg values for particular field-types.Bill Meier1-10/+10
svn path=/trunk/; revision=39568
2011-09-30FT_EUI64 need also to specifies encoding !Alexis La Goutte1-2/+2
svn path=/trunk/; revision=39191
2011-09-29Update README.developer to take into account the disappearance ofGuy Harris1-31/+49
FT_EBCDIC and the addition of support for character encodings. svn path=/trunk/; revision=39190
2011-09-28Add default modeline settings to the end of the skeleton code.Chris Maynard1-0/+14
svn path=/trunk/; revision=39178
2011-09-27Future tense -> present tense for the encoding argument toGuy Harris1-3/+3
proto_tree_add_item() having more than just a byte order. svn path=/trunk/; revision=39170
2011-08-23Remove support for libpcre, we use GRegex in GLib.Stig Bjørlykke1-11/+1
svn path=/trunk/; revision=38683
2011-07-18Add instructions how to work with "git svn" instead of "svn"Jörg Mayer1-1/+29
svn path=/trunk/; revision=38080
2011-07-15Update ptvcursor API description to reflect 'endianness' --> 'encoding' ↵Bill Meier1-5/+5
parameter change. svn path=/trunk/; revision=38048
2011-07-11More GLIB_CHECK_VERSION cleanups. Update the minimum GLib/GTK+ versionsGerald Combs1-4/+5
in README.devloper. Remove g_gnuc.h since it's no longer needed. Remove tvbuff_init(), tvbuff_cleanup(), reassemble_init(), and reassemble_cleanup() since they were only used for older GLib versions which didn't support GSlices. Assume we always support the "matches" operator. svn path=/trunk/; revision=37978
2011-05-08Add FT_EUI64 Field TypeAlexis La Goutte1-1/+19
* Remove proto_tree_add_eui64 function from 802.15.4 Dissector * Replace print_eui64/print_eui64 by eui64_to_str/get_eui64_name * Update Documentation (README.dev) * Add new function in libwireshark.def * Support of encoding for tvb_eui64_to_str * Use FT_EUI64 for ICMPv6, CAPWAP, Zbee ... dissector svn path=/trunk/; revision=37015
2011-04-01Add some info as to the determination of the length of a FT_STRINGZ item.Bill Meier1-0/+7
Add a note not leaving trailing whitespace on a line. svn path=/trunk/; revision=36434
2011-02-10Document that proto_tree_add_bytes_format() andJeff Morriss1-0/+4
proto_tree_add_bytes_format_value() may be given a NULL value_ptr. svn path=/trunk/; revision=35907
2011-02-09Document that NTP times can be added with proto_tree_add_item().Jeff Morriss1-5/+21
svn path=/trunk/; revision=35884
2011-01-26Sharpen the description of preference names.Jaap Keuter1-1/+3
svn path=/trunk/; revision=35671
2011-01-21From Alexis La Goutte via ↵Jeff Morriss1-0/+6
https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=5603 : Following the discussion on the dev mailing list about ett_ value in subtree http://www.wireshark.org/lists/wireshark-dev/201101/msg00039.html a small to update the Readme Developer Guide ! svn path=/trunk/; revision=35610