aboutsummaryrefslogtreecommitdiffstats
path: root/doc/README.developer
AgeCommit message (Collapse)AuthorFilesLines
2017-02-13Make Libgcrypt a mandatory dependencyPeter Wu1-4/+3
Removed all guards for HAVE_LIBGCRYPT, change autotools and CMake to error out if it is not available. Update release notes, developer documentation and README with the new status. Clarify relation with GnuTLS in macosx-setup.sh. Install Libgcrypt via brew script. Motivation for this change is that many dissectors depend on Libgcrypt and having it optional increases the maintenance burden (there have been several compile issues in the past due to the optional status). Furthermore, wsutil has crypto code that can be replaced by Libgcrypt. Change-Id: Idf0021b8c4cd5db70b8766f7dcc2a8b3acbf042f Link: https://www.wireshark.org/lists/wireshark-dev/201702/msg00011.html Reviewed-on: https://code.wireshark.org/review/20030 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com> Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2016-10-20Officially require Qt 4.8 or newerPeter Wu1-5/+4
Since v2.3.0rc0-1002-g1cd2255, Qt 4.8 became mandatory, reflect this in the version requirements. This will not affect a lot of distributions (RHEL and SLES only had Qt 4.6). For a more complete list of supported platforms, see https://wiki.wireshark.org/Development/Support_library_version_tracking While at it, correct some other minimum versions in documentation. Change-Id: I11f2dfba72c75429f6838404a81ed3b3dc302d5f Reviewed-on: https://code.wireshark.org/review/18314 Reviewed-by: Michal Labedzki <michal.labedzki@tieto.com> Petri-Dish: Anders Broman <a.broman58@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2016-09-06Allow a lot more C99 featuresPeter Wu1-21/+14
Flexible array members are supported by gcc, clang and even MSVC2013. Note, so far it was only used in the Windows-specific airpcap.h. Trailing commas in enum declaration are already in use since for these dissectors (commit ID is the first occurrence): epan/dissectors/packet-gluster.h v2.1.0rc0-1070-g3b706ba epan/dissectors/packet-ipv6.c v2.1.2rc0-81-ge07b4aa epan/dissectors/packet-netlink.h v2.3.0rc0-389-gc0ab12b epan/dissectors/packet-netlink-netfilter.c v2.3.0rc0-239-g1767e08 epan/dissectors/packet-netlink-route.c v2.3.0rc0-233-g2a80b40 epan/dissectors/packet-quic.c v2.3.0rc0-457-gfa320f8 Inline functions using the "inline" keyword are supported via all glib versions we support (if it is missing, glib will define a suitable inline macro). Other c99 functions listed in the README.developer document were found to be compatible with GCC 4.4.7, Clang 3.4.2 and MSVC 2013. Change-Id: If5bab03bfd8577b15a24bedf08c03bdfbf34317a Reviewed-on: https://code.wireshark.org/review/17421 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2016-06-15documentation: Suggest using prefixed public symbolsBalint Reczey1-0/+5
Change-Id: I9153756b0e921fd74d7df9d119337f5484856ba0 Reviewed-on: https://code.wireshark.org/review/15940 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2016-04-21Add option to disable version.hJoão Valverde1-0/+10
If the file '.git/wireshark-disable-versioning' exists then version.h will be commented out. Change-Id: If481b673463408a69c2ecf7c2e66d08c5855537f Reviewed-on: https://code.wireshark.org/review/14932 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-03-29Update min. GLib version and add Qt version checksJaap Keuter1-5/+5
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-14Add EditorConfig reference to README.developerJoão Valverde1-6/+23
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-01-02Note that variadic macros *can* be sued.Guy Harris1-1/+4
Change-Id: I15bfda76256e5d1084ad7c64006f93afaf071a9e Reviewed-on: https://code.wireshark.org/review/13010 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2015-11-08Update to reflect current reality.Guy Harris1-29/+20
Change-Id: I98a104407feb21d038653e41c547c7ebc27771cb Reviewed-on: https://code.wireshark.org/review/11636 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2015-10-05Allow use of variadic macrosPeter Wu1-17/+0
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>
2014-12-12doc: remove some references to the now defunct python supportPascal Quantin1-1/+0
Change-Id: Ibba3168516ef28ad050f5f70045acf3935f2b233 Reviewed-on: https://code.wireshark.org/review/5738 Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2014-09-17Update the doc directory to use https://www.wireshark.org.Gerald Combs1-2/+2
Change-Id: I9bfc57cb6b6ab6962b80ff58d98eb351d6f69829 Reviewed-on: https://code.wireshark.org/review/4140 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-13README.dissector was split from README.developer in 2013 - update someJoerg Mayer1-0/+1
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-02-14Remove $Id$ and other Subversion leftovers from the doc files.Jeff Morriss1-3/+0
Change-Id: I28a376f7e0fd90971f65ae9c1105a3ec85221470 Reviewed-on: https://code.wireshark.org/review/204 Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
2013-12-20Change G_GINT64_CONSTANT(xxxxU) to G_GUINT64_CONSTANT(xxxx)Jakub Zawadzki1-2/+2
svn path=/trunk/; revision=54314
2013-11-01Remove a phrase which implies that tab widths other than 8 are OK.Bill Meier1-4/+4
svn path=/trunk/; revision=53030
2013-10-13Subsume README.binarytrees into wmem doxygen. The README was out of dateEvan Huus1-1/+0
anyways, since Michael made key operations non-destructive in r44380. svn path=/trunk/; revision=52583
2013-09-22emem -> wmem conversion:Pascal Quantin1-2/+2
- 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-03Document the current state of naming in ui/qt. Say it's OK to use C++Gerald Combs1-4/+5
comments in C++ code. svn path=/trunk/; revision=51739
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
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-03 05:19:29 +0000