aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/wsdg_src
AgeCommit message (Collapse)AuthorFilesLines
2020-01-09WSDG: Update the libraries chapter.Gerald Combs1-30/+45
C-ares is required, so don't mark it as optional. Add Win64 download URLs and list them first. Zlib is part of our vcpkg bundle. Change-Id: I232f4df988aa12afde0b66fff203187136504e94 Reviewed-on: https://code.wireshark.org/review/35700 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>
2020-01-03WSDG: More translation updates.Gerald Combs1-7/+22
Update the Transifex URL and describe how its resources are organized. Change-Id: Icc03ff57da73c0a60da0ea1e7ff19d6ecffae3a1 Reviewed-on: https://code.wireshark.org/review/35637 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-01-03WSDG: Miscellaneous updates.Gerald Combs3-22/+21
Add a note about case sensitive directories on Windows. Recommend the "winflexbison3" Chocolatey package. Update our list of Linux distributions. Change-Id: I4676453941a66de71215d6ce6cf7057623c92fec Reviewed-on: https://code.wireshark.org/review/35622 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-01-03Qt: Add Spanish (es) translation assets.Gerald Combs1-0/+1
Add an initial "es" Qt translation file and an accompanying flag image. The image came from https://en.wikipedia.org/wiki/File:Flag_of_Spain.svg and is in the public domain. (We already had a debian/po/es.po.) Change-Id: I5378ad2cbffb2267389fc8ae6af6d591071e0144 Reviewed-on: https://code.wireshark.org/review/35620 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2019-12-30Guides: Update some of the MaxMind text.Gerald Combs1-1/+3
Update the User's Guide to match MaxMind's upcoming database access changes: https://blog.maxmind.com/2019/12/18/significant-changes-to-accessing-and-using-geolite2-databases/ Add a Win64 link to the Developer's Guide. Change-Id: Iaaaaedeb81616f026c542c6f2d8559a3a0084f95 Reviewed-on: https://code.wireshark.org/review/35610 Reviewed-by: Jaap Keuter <jaap.keuter@xs4all.nl>
2019-12-14WSUG+WSDG: Remove description list formatting.Gerald Combs1-4/+4
Remove the last of our description list term formatting. This is better handled using CSS. Update the filter expression dialog DL text. Change-Id: Ib21e2ee5265c9b476d960e7d73ac99b25b646141 Reviewed-on: https://code.wireshark.org/review/35437 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-12-10More Qt minimum version updates.Gerald Combs1-1/+1
Update the minimum version in various documents. Remove some no-longer-needed code from scripts that call windeployqt. Change-Id: I16da4bced9780c9f1b1969aae7c52e2fce1968aa Reviewed-on: https://code.wireshark.org/review/35391 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2019-12-07Docbook: Updates for Windows 7 and macOS.Gerald Combs1-3/+1
Update some of the FAQ and WSUG content for Windows 7's impending demise. Add supported releases for macOS and other updates. Change-Id: I5741ac631f39803fa060e9f5c2006a75cb54136f Reviewed-on: https://code.wireshark.org/review/35333 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-11-28docbook: make all examples use 64bit architecture.Dario Lombardo2-10/+10
The WSDG is a mix of references to 32 and 64 architectures. Use 64 in more places. Change-Id: Ifb4b3189912268808cfe8fdb5119f2177c815163 Reviewed-on: https://code.wireshark.org/review/35248 Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-27docbook: put a space after PS prompts.Dario Lombardo3-10/+10
Change-Id: I7e55471b19a3dd526d1de1269062853a72e75dec Reviewed-on: https://code.wireshark.org/review/35226 Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-27docbook: add warning about using an old version of Windows.Dario Lombardo1-0/+4
Change-Id: I537fbb26681555d0cd303d4b614bc016e935eb70 Reviewed-on: https://code.wireshark.org/review/35225 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-27docbook: minor fixes.Dario Lombardo1-3/+3
Change-Id: I2de1f3df60847b011e7b93d12a0b73e581c4a9d7 Reviewed-on: https://code.wireshark.org/review/35222 Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-21docs: fix up MS toolchain referencesGraham Bloice2-41/+19
Updated the toolchain references to VS 2019, removing mentions of 2015 & 2017. Bug: 16211 Change-Id: Ic1607ac2c2713a5d324d40319c4e1be5365eb6f7 Reviewed-on: https://code.wireshark.org/review/35180 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Guy Harris <guy@alum.mit.edu> Tested-by: Petri Dish Buildbot Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-11-16WSDG: Remove duplicate paragraphGraham Bloice1-10/+0
Change-Id: Ia96444bc463337e0ffb050a05ce4d454dd18986d Reviewed-on: https://code.wireshark.org/review/35103 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-04Qt: Coloringrules Mime is encoded as JSONRoland Knall1-26/+15
Encode coloring rules as json objects to avoid encoding issues Change-Id: I4b5369fef3c0f9e73cbb08edf14de6535ff35026 Reviewed-on: https://code.wireshark.org/review/34947 Petri-Dish: Roland Knall <rknall@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Roland Knall <rknall@gmail.com>
2019-11-04Qt: Remove DisplayFilterMimeDataRoland Knall1-0/+17
Make the mimetype for the display filter more generic, so that external programs can attach to Wireshark and users can drag and drop display filters to the program Change-Id: Id78b4dff7883e3dab879a31aad07f577d8cc4ee3 Reviewed-on: https://code.wireshark.org/review/34936 Reviewed-by: Roland Knall <rknall@gmail.com> Petri-Dish: Roland Knall <rknall@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-03Qt: Consolidate mimedata usageRoland Knall1-0/+67
Ensure, that all mimedata uses similar mimetypes and document the mimetypes being used throughout wireshark Change-Id: I7c02d0a5e12a823153640e600051abb95d58cdeb Reviewed-on: https://code.wireshark.org/review/34923 Petri-Dish: Roland Knall <rknall@gmail.com> Reviewed-by: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Roland Knall <rknall@gmail.com>
2019-10-08WSDG: Fix duplicate 'the the'Moshe Kaplan1-1/+1
Change-Id: Iaa383391daa6deb569852fe4bb464f7cda3658dd Reviewed-on: https://code.wireshark.org/review/34726 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-09-26Docbook: Update macOS packaging.Gerald Combs1-3/+3
Update the macOS packaging sections to reflect current reality. Change-Id: I6795787c0d4d3c9a85da14bdb69a31fc74e9ddf2 Reviewed-on: https://code.wireshark.org/review/34624 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-09-16WSDG: Add an "or".Gerald Combs1-1/+1
Change-Id: I3f068dcdf4b7df1e54a742ccf55983aae200eba5 Reviewed-on: https://code.wireshark.org/review/34550 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-09-16WSDG: Visual Studio fixes.Gerald Combs1-15/+7
Convert a single numbered list to a simple paragraph. Generalize a reference to to the VS Community Edition in one place and fix the VS version in another. Start using one sentence per line as recommended at https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line Change-Id: Iaa2a830d6cdb034c8057e4a6c45935e65d1d387e Reviewed-on: https://code.wireshark.org/review/34519 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-09-16Docbook: Fixup our table delimiters.Gerald Combs2-4/+4
Update our table delimiters to match the Asciidoctor documentation. Change-Id: I87a6834f2889e175236aa609984a9bc4dd9d3b8e Reviewed-on: https://code.wireshark.org/review/34544 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-09-12WSDG: Updates for Visual Studio 2019.Gerald Combs1-17/+17
Start recommending Visual Studio 2019. Change-Id: I743844691baf6798f708aca48dd73da8d7fb6aeb Reviewed-on: https://code.wireshark.org/review/34508 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-08-09Update the set of buildbots to the current reality.Guy Harris2-7/+8
(That's the master and 3.0.x buildbots; the 2.6 Mac buildbot is running an older version of Apple's UNIX-for-Macs - sufficiently older that Apple's name for it was different back then.) While we're at it, note that it's been updated past VS 2013. Change-Id: I063daa7c38ff58aed0c77950d4265b5544783f2c Reviewed-on: https://code.wireshark.org/review/34217 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-07-20Documentation: convert http URLS to httpsPeter Wu5-67/+50
Remove some dead links or point them to archive.org while at it. All updated links have been verified. Change-Id: Icf02167a13d5fe9dfce39ea57525b3f185554c9d Reviewed-on: https://code.wireshark.org/review/34028 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-06-25Qt: Use a lighter link color in dark mode.Gerald Combs1-1/+15
Add ColorUtils::themeLinkBrush, which returns a readable link color in dark mode. Use it in place of existing ...palette().link() calls. Add ColorUtils::themeLinkStyle, which produces an HTML <style/> block that lightens the link foreground color in dark mode. Use this to style links in the about box and in elided labels. Catch ApplicationPaletteChange events where needed. Add dark theme / dark mode notes to the WSDG. Ping-Bug: 15511 Change-Id: I92925bd997f97b155491f55a8c818f03549bc7f4 Reviewed-on: https://code.wireshark.org/review/33704 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-06-17WSUG: Clarified and improved phrasingMoshe Kaplan1-3/+2
Change-Id: I1b3b8b7bf5f6460aa779c54881abd53059b26bbb Reviewed-on: https://code.wireshark.org/review/33606 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>
2019-06-09Document why extcap utilities can't be run "by hand" on WindowsMichael Mann1-0/+6
Bug: 15591 Change-Id: Icb8246ba196df026736ce1e54eb2ace2c7cd49b0 Reviewed-on: https://code.wireshark.org/review/33530 Petri-Dish: Michael Mann <mmann78@netscape.net> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-05-30WSDG: refine text on cloning repositoryJaap Keuter1-4/+4
Text smells of CVS/SVN heratige. Change-Id: I37c3309781f49149b2603ae32087ed01363460ee Reviewed-on: https://code.wireshark.org/review/33421 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot Reviewed-by: Martin Kaiser <wireshark@kaiser.cx>
2019-05-28docbook: add a link to the gerrit manual explaining change-ids.Dario Lombardo1-1/+4
Change-Id: I775e05bac8b0f8988d503bde6091922d2fab2583 Reviewed-on: https://code.wireshark.org/review/33381 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-05-25Developers Guide: Fix issue with Windows env varsGraham Bloice1-6/+0
Change-Id: I2f78cf59267196c2994f7f16934562074afa9f4f Reviewed-on: https://code.wireshark.org/review/33358 Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2019-05-24developers-guide: restore winflexbison to Windows installGraham Bloice1-23/+38
Change-Id: I46d0822b2939793990b7e0ef6a34bd421335c919 Reviewed-on: https://code.wireshark.org/review/33337 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot Reviewed-by: Guy Harris <guy@alum.mit.edu> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-05-20docbook: add section from wiki.Dario Lombardo1-1/+57
The section "Writing a Good Commit Message" from the wiki has been incorporated in the wsdg. Missing parenthesis fix, while here. Bug: 15752 Change-Id: I93f2a6956d366b3e1db0deab6d884f67748d3c54 Reviewed-on: https://code.wireshark.org/review/33254 Petri-Dish: Dario Lombardo <lomato@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-05-01Windows: Modernize our WSAStartup usage.Gerald Combs1-1/+1
Make sure we link each application that calls WSAStartup with ws2_32.lib. Pass version 2.2 to WSAStartup. Wikipedia says it was introduced in 1996, so we should be OK. Ping-Bug: 15711 Change-Id: I431839e930e7c646669af7373789640b5180ec28 Reviewed-on: https://code.wireshark.org/review/33033 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Tomasz Moń <desowin@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-04-22docbook: fix broken image link on ChLibsNpcapPeter Wu1-1/+1
Only warning, note and tips admonitions are documented for use in the "Typographic Conventions" section. Asciidoctor also supports IMPORTANT and CAUTION, but we do not use it. Remove it to avoid broken pictures. Extcap is another user, but that is being removed in another patch. Change-Id: Iea7c9e67ddb978ae1b9c18e5d8f65b0cfb0d6f2c Reviewed-on: https://code.wireshark.org/review/32936 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-04-19WSDG/Capture: Fix typo in extcap_example.py namePeter Wu1-6/+6
Change-Id: I0f1bff75e90f37d07afcbe3bb786965db9cb442e Reviewed-on: https://code.wireshark.org/review/32900 Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-03-04WSDG: Describe our tag naming conventions.Gerald Combs1-4/+11
Change-Id: Icb8ba1be843b8a109713df9260330df5b215bf0b Reviewed-on: https://code.wireshark.org/review/32318 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-02-19WSDG: Let Windows developers know that they need Perl.Gerald Combs2-4/+18
Add an "Install Perl" section to the "Win32/64: Step-by-Step Guide" section. Recommend Strawberry Perl first there and in the "Microsoft compiler toolchain" chapter under the theory that if it's good enough for Larry Wall then it's good enough for us. Bug: 15512 Change-Id: I9a01c7ae2da01b98fd20b64d29144577a8f456b2 Reviewed-on: https://code.wireshark.org/review/32088 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-16Remove whitespace from the end of the line.Guy Harris1-1/+1
Change-Id: I9dc504e8f5ab97021876f12376ac2c6f20258288 Reviewed-on: https://code.wireshark.org/review/32052 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-02-16VS 2017 and later include the redistributables even in Community versions.Guy Harris1-4/+19
Change-Id: I540273976dc0e99620894b45b7fa14093e55aa08 Reviewed-on: https://code.wireshark.org/review/32051 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-02-15Give the current URL where you can find the VS redistributables.Guy Harris1-1/+4
(Fix a typoo while we're at it.) Change-Id: I2129c301ea377a9fb48b3f5abd418f7319659638 Reviewed-on: https://code.wireshark.org/review/32050 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-02-15Rename our .asciidoc files to .adocGerald Combs12-2/+2
As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 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-02-08WSDG: Windows toolchain updates.Gerald Combs1-19/+21
Update some items in the toolchain section. Change-Id: I3c2035873d4ee311b639dd3b5c94e3530abad8bc Reviewed-on: https://code.wireshark.org/review/31944 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-02-07CMake: Make sure we deploy Qt PDBs on Windows.Gerald Combs1-8/+10
Pass "--pdb" to windeployqt 5.6 and later. Add a note about installing the "Qt Debug Information Files" component to the Developer's Guide. Change-Id: I81329bc9f9131050b1076fe275445b6325c24794 Reviewed-on: https://code.wireshark.org/review/31921 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-24Test: enable capture tests by default using the Loopback interfacePeter Wu1-11/+3
Avoid pinging www.wireshark.org, this removes an external dependency. Instead send small UDP datagrams to UDP port 9 (discard) every 50ms. Enable this for all platforms (including macOS and Linux) by default. On Windows the tests requires Npcap and will be skipped with WinPcap. Remove the --capture-interface option since it is no longer needed. Copy WSDG Wireshark Tests Quick Start to README.test and add a link. Change-Id: Id4105a6b1e95407ebf69b871c785c68f9ae26368 Reviewed-on: https://code.wireshark.org/review/31677 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-01-21test: fail tests when programs are missingPeter Wu1-5/+16
Building only a subset of programs is not a very common situation, it is more likely that some feature was accidentally disabled. For that reason, fail tests by default unless a program is explicitly permitted to be missing. The '-v' test is now dropped from the Travis tests, the sole reason of adding it was to see which tests got (accidentally) skipped. Change-Id: I725f4508541d8ed980e17d69fb7aee1ad2875d73 Reviewed-on: https://code.wireshark.org/review/31660 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-01-17WSDG: make Testing more accessible, add missing anchorsPeter Wu2-46/+70
Rename sections to avoid files named like _documentation_toolchain.html and _adding_or_modifying_tests.html. Rewrite the testing introduction to directly show the required commands for the pytest method. That provides much nicer output and finishes faster, except when you cannot install extra build dependencies there should be no reason to avoid it. ctest is removed from the description since it does not provide many advantages over the test target (except for the possibility of adding --verbose I guess). Group some related sections under a "Test suite structure" heading in order to collect some small sections on a single page. Fix some other grammatical issues while at it. Change-Id: I8ab821a67254e62c0fc3d18630e4bc8b0ef872dd Reviewed-on: https://code.wireshark.org/review/31550 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-01-15make-version.pl updates.Gerald Combs1-6/+12
Read our major, minor, and micro versions from CMakeLists.txt. Add the ability to set our extra version information differently if our Git commit is tagged or untagged. Change our extra version placeholder from "%#" to "{vcsinfo}". Add --tagged-version-extra (-t) and --untagged-version-extra (-u) arguments for specifying the tagged and untagged extra formats. Add --force-extra (-f) so that we can force one format or the other. Require the major.minor.micro version to be specified when using --set-version (-v). Update appveyor.yml and the Developer's Guide to match the new behavior. Change-Id: I6e5d55470aff7e7c61e75f208e24c4105276905a Reviewed-on: https://code.wireshark.org/review/31479 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>
2019-01-10CMake: try harder to find the right Python versionPeter Wu1-3/+0
The FindPythonInterp module does not verify that a discovered 'python' program is actually Python 3. Replace this deprecated module by a modern version that was introduced with CMake 3.12. Remove PYTHON_EXECUTABLE from WSDG now that it is much more likely that CMake discovers the right version. Change-Id: I1f8438baced3d5bf9e1e2732980ad177d3257ca3 Reviewed-on: https://code.wireshark.org/review/31468 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-01-10WSDG: Move README.packaging to the Developer's Guide.Gerald Combs1-6/+129
Move doc/README.packaging to the Developer's Guide and update the content. Change-Id: I25fda6cade8f3cfd11af865745bedd0fb5a7c86f Reviewed-on: https://code.wireshark.org/review/31474 Reviewed-by: Anders Broman <a.broman58@gmail.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-22 11:47:46 +0000