aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/wsdg_src
AgeCommit message (Collapse)AuthorFilesLines
2019-01-09CMake,WSDG: Remove Cygwin supportPeter Wu2-110/+9
Declare Cygwin as unsupported and remove all supporting code. Simplify some Chocolatey notes in the WSDG. Remove FindPerl.cmake as it only existed to force use of Wireshark's bundled FindCygwin.cmake (bug 13922). FindXSLTPROC.cmake special handling for Cygwin was also removed, in theory this could cause issues when the PATH contains a Cygwin xsltproc, but it's unsupported anyway. Change-Id: Iabfac2b4a9fd930530505d27bdba618bdb8f7f34 Reviewed-on: https://code.wireshark.org/review/31452 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-01-06Fix typo.Guy Harris1-1/+1
Change-Id: I03291922ddef34ab1408684df650dbac191a2020 Reviewed-on: https://code.wireshark.org/review/31401 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-01-06Fix link, don't put it separately from the introductory words.Guy Harris1-3/+2
Change-Id: If144fb08d27886ae1bf3610c2157c8a25d1de75e Reviewed-on: https://code.wireshark.org/review/31400 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-01-06Replace ancient notes about modifying libpcap with a link to a newer doc.Guy Harris1-54/+22
Instead of giving horribly out-of-date instructions on how to add a new module to libpcap, just point to the document that I started whipping up earlier today (it definitely needs work - it's incomplete - but I'll be getting back to it). While we're at it, update the notes on adding support for new LINKTYPE_ values to libwiretap, and note that it's only necessary if you had to add a new DLT_ *and* there isn't already a WTAP_ENCAP_ value that would correspond to that DLT_. Change-Id: I3882d0a57b29e98f73c074317bc6df7458fcc677 Reviewed-on: https://code.wireshark.org/review/31397 Petri-Dish: Guy Harris <guy@alum.mit.edu> Tested-by: Petri Dish Buildbot Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-01-05WSDG: update testing section to cover use of pytestPeter Wu1-11/+70
Remove traces of the "config" module, it was removed. Add a new section on using pytest. Change-Id: I763fc53359157f5fcb04198ed98e2d7f7a2c7220 Reviewed-on: https://code.wireshark.org/review/31372 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-01-04Finish migrating to Asciidoctor's modern syntax.Gerald Combs3-18/+18
Finish migrating the User's and Developer's guides to modern syntax. Remove :compat-mode: from attributes.asciidoc. Change-Id: I1232676c6ef4c3638253d070dcbae6d3c1ead284 Reviewed-on: https://code.wireshark.org/review/31374 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-01-04WSDG: Add a note about Npcap licensing.Gerald Combs1-2/+20
Expand the Npcap text. Make it clear that you might need to purchase a license to redistribute Npcap. Change-Id: I9340ed2d363e66443797478c59859ce10d648aff Reviewed-on: https://code.wireshark.org/review/31351 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-01-04WSDG: Stop recommending DDD.Gerald Combs2-27/+12
Drop mentions of DDD in favor of Qt Creator, CLion, and Eclipse. From looking at https://sourceware.org/gdb/wiki/GDB%20Front%20Ends I'm guessing that those have superseded DDD, as nice at it is/was. Change-Id: I445a909ab8c8aa73c90f868d6b0958bb8faf62d6 Reviewed-on: https://code.wireshark.org/review/31353 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-01-03Put a period at the end of a sentence.Guy Harris1-1/+1
Change-Id: Ifad6b9a09bc052d687cefe3ccda8c07ad765abda Reviewed-on: https://code.wireshark.org/review/31350 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-01-03Slight fixup for where the capture code lives.Guy Harris1-2/+3
The full explanation is a bit more complicated - we'd have to mention the dumpcap/*shark split, and the code on both sides of the split. Change-Id: I43f8fc3c589bdf900e20714b55a3b4f544879bc2 Reviewed-on: https://code.wireshark.org/review/31349 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-01-03WSDG: Miscellaneous updates and fixes.Gerald Combs7-123/+162
Update the Windows CRT text to mention the Universal CRT. Replace references to WinPcap with Npcap. Update the Qt LTS text. Add a WiX / .msi section Use curly quotes. Use the {cpp} attribute so that the "++" in "C++" doesn't trigger monospace formatting. Make the various "Unix" and "Windows" subsection title names uniform. Give them the "discrete" attribute so that they don't clutter up the TOC. Title-case section titles. Remove the reference to m4. As far as I can tell we don't require it. Change-Id: I73f851adae640f77205781d6c4962002c2d53f49 Reviewed-on: https://code.wireshark.org/review/31343 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-11-29Drop support for GnuTLS 2.12.x, require GnuTLS 3.2 or newerPeter Wu1-3/+3
Upcoming changes need GnuTLS >= 3.0.2. Require GnuTLS 3.2 (or newer) for licensing reasons. The Debian control file still mentions 3.2.14 because older packages linked with a GMP library that was not GPLv2+ compatible. RHEL6 only has 2.12.23, but is already unsupported anyway. Change-Id: I024b2a734ebb16b73a624bb2435c254e963d8b7d Reviewed-on: https://code.wireshark.org/review/30832 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-11-14WSDG: update test section with pytest fixturesPeter Wu1-14/+54
Try to describe the motivation of pytest fixtures and update the examples. Add a missing build dependency in CMake while at it. Change-Id: I5384a86f2191835b834285b81343a7ee56f88e79 Reviewed-on: https://code.wireshark.org/review/30632 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-11-12fix documentation and tests for cmake run directory.Dario Lombardo1-1/+1
Change-Id: If33a39c26714ebe699463d1c8c67469025767efb Reviewed-on: https://code.wireshark.org/review/30581 Petri-Dish: Dario Lombardo <lomato@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-11-07Require Python 3, drop Python 2 supportPeter Wu5-44/+33
Python 3 is widely available. All major Linux distributions support it. RHEL is covered via EPEL (which is already required for cmake3). Drop support for Python 2 in order to reduce maintenance costs. The main motivation is being able to simplify the tests. CMake is updated to search for Python >= 3.4 and will fail if unavailable (generating dissectors.c requires Python, so it is quite an important piece to have). The documentation is updated to reflect the Python 3.7 paths used by Chocolatey. Tested the git-review installation instructions in Windows 7 x64 without a previous Chocolatey installation. macOS brew now installs Python 3 (its dependencies are already installed by python@2 for libxml2). The macOS (non-brew variant) is updated to use the official 64-bit installer to install Python 3. Change-Id: I80b1e36957f338e0dad1bfcc173b6418682cddba Reviewed-on: https://code.wireshark.org/review/30192 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-11-07docbook: Fix a typoStig Bjørlykke1-1/+1
Change-Id: I41b3626bdfac54291fb3d8be0deb035c1a9f9f55 Reviewed-on: https://code.wireshark.org/review/30529 Reviewed-by: Stig Bjørlykke <stig@bjorlykke.org>
2018-10-14Update VS command prompt menu names for VS 2017.Guy Harris1-7/+7
At least on my W10 machine, they shols up as "xxx Native Tools Commmand Prompt for VS 2017", not "VS2017 xxx Native Tools Command Prompt". Change-Id: I55d7ad24df717cfce21f6abdaf97ed1972128e3c Reviewed-on: https://code.wireshark.org/review/30215 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-10-13Update installation instructions for MSVC and Qt.Guy Harris1-10/+12
Change-Id: Id610d4d11a0aaa132c0a528a8dfcb41c1cfc4215 Reviewed-on: https://code.wireshark.org/review/30197 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-10-12We don't support VS prior to 2015 in the master branch.Guy Harris1-83/+3
Change-Id: I16380ca9205832960c0b2e7f43e237797d7671b6 Reviewed-on: https://code.wireshark.org/review/30188 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-10-12Fix section anchor.Guy Harris1-2/+2
Change-Id: I5480c643c44698af764297feb77750850ffefde8 Reviewed-on: https://code.wireshark.org/review/30186 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-10-12Consistenly use "Windows native" rather than "Windows Native".Guy Harris2-5/+5
Change-Id: I40164b892e48dc4f484f8e24451b29c68a0da62d Reviewed-on: https://code.wireshark.org/review/30182 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-10-12Fix typoes introduced by the previous change.Guy Harris2-2/+2
Change-Id: Ifc3b2c4d51e935f8cb4c5514e6c1f0c4bb9007ba Reviewed-on: https://code.wireshark.org/review/30180 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-10-12Some cleanups.Guy Harris2-21/+25
More use of "UNIX-like" as the term for "macOS and Linux and *BSD and Solaris and AIX and..." or, alternatively, for "not Windows". Add Fedora as a Linux distribution for which packages are available. Use "Windows" rather than "Win32" in more cases; "Win32" dates back to the days when the big difference was between Boring Old 16-bit Windows and modern shiny new 32-bit Windows, but the former is now dead and the latter now supports both 32-bit and 64-bit machines and software. More people have probably never heard "Win32" but are familiar with "Windows". *ALL* UNIX-like platforms support symlinks; Linux wasn't even the first one, it just picked them up from the UN*Xes with which it was trying to be compatible. Change-Id: I254e74f0ed3c86b55d00f9e8d7b78d009b61fb5e Reviewed-on: https://code.wireshark.org/review/30178 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-10-12Updates.Guy Harris3-39/+49
We use VS 2017, not VS 2015, for 2.6.x and development builds. Microsoft's documentation is moving from msdn.microsoft.com to docs.microsoft.com. The way you download pre-2017 versions of VS has changed. Update links to the Android, GNOME, KDE and macOS human interface guidelines while we're at it. Change-Id: I1a3973f76aa5b476cb906b8a8604b82d6131e9c5 Reviewed-on: https://code.wireshark.org/review/30168 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-09-24Revert "Stop advertising support for Solaris."Gerald Combs1-2/+1
This reverts commit 5dd0c8daa5578bc748424005630e970c2a871dc4. Reason for revert: As Guy pointed out, Oracle ships a recent version. Change-Id: I9689dfd0656d95f7ae57ae86c2bea7d09afddc70 Reviewed-on: https://code.wireshark.org/review/29815 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-09-21Stop advertising support for Solaris.Gerald Combs1-1/+2
Stop listing Solaris as a supported platform. I'm not sure if you can compile Wireshark out of the box on it any more and the available binary packages I can find are ancient. Change-Id: I89afef01abe05986ce660327731c5504c6622ff7 Reviewed-on: https://code.wireshark.org/review/29764 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-09-13Start renaming SSL to TLS.Gerald Combs1-1/+1
Rename the "ssl" protocol to "tls" and add an "ssl" alias. Prefer "TLS" over "SSL" in user interface text and in the documentation. Fix the test_tls_master_secret test while we're here. Bug: 14922 Change-Id: Iab6ba2c7c4c0f8f6dd0f6d5d90fac5e9486612f8 Reviewed-on: https://code.wireshark.org/review/29649 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-09-07We build Wireshark with Qt 5.9.5 on Windows; update the developer's guide.Guy Harris1-2/+2
Change-Id: Ifebe4b72f35466ddc78bccc96b145afa400ad715 Reviewed-on: https://code.wireshark.org/review/29460 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-08-31docbook: Remove non-existing 'Payload Length'Stig Bjørlykke1-4/+1
Remove 'Payload Length' from extcap toolbar control protocol because this does not exist in the protocol. Change-Id: I9eea7366d2992a7b7ac769f290c5d7e8e1090ce8 Reviewed-on: https://code.wireshark.org/review/29378 Reviewed-by: Stig Bjørlykke <stig@bjorlykke.org>
2018-08-22WSDG: Miscellaneous fixups.Gerald Combs2-18/+18
Change occurrences of GIT to Git. Fix a couple of URLs. Other changes. Change-Id: I9eb69ee16f692c2bf71b62e7a2db4b762d9ab4bf Reviewed-on: https://code.wireshark.org/review/29237 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-07-26--extcap-version requires = if it has an argument.Guy Harris1-2/+2
The version argument to --extcap-version is optional, and some versions of getopt_long() require, for a flag whose argument is optional, that the argument be supplied as --flag=value, not --flag value. Change-Id: I5e34132d8bb729b845ac75ff94d6d548c1c35a3d Reviewed-on: https://code.wireshark.org/review/28864 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-07-16extcap: Correct doc structureRoland Knall1-6/+6
Some issues in the developer doc have been corrected Change-Id: I0d60e9080ef582dafa12607fb5ea43a8ae5d2d0f Reviewed-on: https://code.wireshark.org/review/28727 Reviewed-by: Roland Knall <rknall@gmail.com>
2018-07-13extcap: Create docbook documentationRoland Knall1-0/+443
Move the information from README.extcap into docbook. Change-Id: Ic6504787750d04fe6c66479896cba8d6148d804d Reviewed-on: https://code.wireshark.org/review/28690 Reviewed-by: Roland Knall <rknall@gmail.com> Reviewed-by: Jaap Keuter <jaap.keuter@xs4all.nl>
2018-07-06Developer Guide: UpdatesDylan Ulis3-17/+11
1. Use proto_tree_add_bitmask for the flags example 2. GLib download link was dead 3. Remove old frontend information. I can't find any download for hethereal, and Packetyzer is so old that it's not useful for any current developers. Change-Id: Ifa0a7363fccb95fb2ef315d84fbbcf7414ae6a6d Reviewed-on: https://code.wireshark.org/review/28632 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-06-28docbook: add info about using symbolic links for git hooks.Dario Lombardo1-0/+6
Change-Id: I4b448c1a12946479638d04819570f5a0dd1227dd Reviewed-on: https://code.wireshark.org/review/28497 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-06-26WSDG: Fix a couple of links.Gerald Combs1-2/+2
Change-Id: I6f96ac45cd3cd4f992c11dea0f0aff6df2a2bff8 Reviewed-on: https://code.wireshark.org/review/28469 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-06-08Qt: Move wireshark-qt.cpp back to ui/qt/main.cpp.Gerald Combs1-1/+1
The Qt UI's main module started out as ui/qt/main.cpp but was moved to the top-level directory in order to appease Autotools. We don't need to do that any more, so move it back. Change-Id: Ic5bc0ed5b754e36cc2b9e682f2ca097781233dfd Reviewed-on: https://code.wireshark.org/review/28090 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-05-15Mention how to get Ninja, and speak more of UNIX and UNIX-like platforms.Guy Harris1-19/+36
And put hyphens in "out-of-tree" and "in-tree". Change-Id: I55c54a1334f490f948310139741fecf27203a359 Reviewed-on: https://code.wireshark.org/review/27550 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-05-15Don't speak of "UNIX".Guy Harris1-7/+8
macOS is a UNIX(R) and FreeBSD isn't a UNIX(R), but we mentioned macOS along with UNIX but didn't mention FreeBSD along with UNIX. Instead, just speak of "UN*Xes" and give Linux, macOS, and *BSD as examples. Feel free to add Solaris, AIX, or HP-UX if you want, assuming you can build Wireshark on them. Change-Id: I85be3861fa0bc603b93d077a2d9d587d43cb6e7e Reviewed-on: https://code.wireshark.org/review/27549 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-05-04docbook: add "-y" to all windows choco commands.Dario Lombardo1-13/+13
This speeds up the copy/paste step-by-step sequence. Change-Id: Ib2e3ee54c8c86b7357260ecaab5d129ef296a9e9 Reviewed-on: https://code.wireshark.org/review/27309 Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-05-03WSDG: Stop recommending Cygwin.Gerald Combs2-237/+160
Note in the quick setup and tools documentation that we no longer require or recommend Cygwin. Change-Id: Ie0eb92c5817ae1d786136035adf8fa3988c8b98d Reviewed-on: https://code.wireshark.org/review/27244 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-04-30Test: Add unittests.Gerald Combs1-0/+3
Note that these require the "test-programs" target. Change-Id: I1bea381eaa48504fcd76f88e1c6f2edece0a78a2 Reviewed-on: https://code.wireshark.org/review/27231 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-30WSDG: Remove ENABLE_CHM_GUIDESDylan Ulis1-1/+1
ENABLE_CHM_GUIDES is no longer in CMakeOptions.txt Change-Id: I217ac89f12c95e66591465e3230c19968dcc0bde Reviewed-on: https://code.wireshark.org/review/27209 Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2018-04-27Test: Add fileformats and I/O.Gerald Combs1-1/+8
Add the fileformats and I/O suites. Move some more common code to subprocesstest.py and add a diffOutput method. Change-Id: I2ec34e46539022bdce78520645fdca6dfc1a8c1a Reviewed-on: https://code.wireshark.org/review/27183 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-26Start porting our test scripts to Python. Add ctest support.Gerald Combs1-0/+170
Create Python versions of our various test shell scripts. Add CMake tests for each suite. Tests can now be run directly via test.py, via the "test" target, or via ctest, e.g. ctest --verbose --jobs 3 Add a testing chapter to the Developer's Guide. Add a way to disable ctest in dpkg-buildpackage. Suites completed: - capture - clopts - decryption - dissection Remaining suites: - fileformats - io - mergecap - nameres - text2pcap - unittests - wslua Change-Id: I8936e05edefc76a86b6a7a5da302e7461bbdda0f Reviewed-on: https://code.wireshark.org/review/27134 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-25Remove some references to autotools from developer documentation.Guy Harris1-13/+4
Change-Id: I4c95e56e067eed98d269812225256462dfa46273 Reviewed-on: https://code.wireshark.org/review/27140 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-04-18Remove autotools build system.Dario Lombardo3-24/+29
It has been replaced by cmake. Change-Id: I83a5eddb8645dbbf6bca9f026066d2e995d8e87a Reviewed-on: https://code.wireshark.org/review/26969 Petri-Dish: Dario Lombardo <lomato@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-04-17Switch the Doxygen API reference build to CMake.Gerald Combs1-1/+1
Switch to a single Doyxgen configuration which was generated using a recent version of Doxygen and customized to suit our needs. Add wsar_html and wsar_html_zip targets to CMake. Update some Doxygen markup and documentation as needed. Change-Id: Ic8a424b292c35a26f74ae0b53322265683e56e69 Reviewed-on: https://code.wireshark.org/review/26976 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-04-15Remove some references to PortAudio.Gerald Combs1-22/+0
Change-Id: Icfe9516ff814db5362aa345e6f527551dcb13935 Reviewed-on: https://code.wireshark.org/review/26946 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-04-09Docs: Remove a bunch of GTK+ references.Gerald Combs6-201/+31
Change-Id: Icab98813d0b81a7337562e9857429d4bb98dc44c Reviewed-on: https://code.wireshark.org/review/26817 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>