aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/wsdg_src
AgeCommit message (Collapse)AuthorFilesLines
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>
2018-04-06Remove some references to Qt4.Gerald Combs1-2/+1
Change-Id: I50f5abafb8adf18a5407427f7feb260301df45cc Reviewed-on: https://code.wireshark.org/review/26771 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-03-26CMake: Add an rpm-package target.Gerald Combs1-28/+34
Copy the current wireshark.spec.in and update it for use with CMake. Remove the Qt4, GTK+2, and GTK+3 options. Add Ninja and mmdbresolve options. The rpm-package target builds a tarball using git-export-release.sh and therefore must be run from a git checkout. The RPM _prefix macro is set to CMAKE_INSTALL_PREFIX, so you'll probably want to run cmake -DCMAKE_INSTALL_PREFIX=/usr ... Change-Id: Ib014494d8858a0059126404cd91528ded5d8a9f6 Reviewed-on: https://code.wireshark.org/review/26579 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Jaap Keuter <jaap.keuter@xs4all.nl> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-03-17NSIS: Link to Npcap.Gerald Combs2-9/+5
Mention Npcap on the WinPcap installer page and add a link to it. Update some other text and tell developers to use NSIS 3.0 while we're here. Change-Id: I64728f014f518439ba4a38eda7a283274d40fcdc Reviewed-on: https://code.wireshark.org/review/26515 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-03-17WSDG: More CMake updates.Gerald Combs2-13/+62
Switch a build example to CMake + Ninja. Add syntax highlighting annotations. Change-Id: I5ee0af548f44ed5be6f6e8367f5167dc499df017 Reviewed-on: https://code.wireshark.org/review/26514 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-03-16More CMake documentation updates.Gerald Combs1-6/+12
Change-Id: Ia568e0f46e7a38007bb9b8ea3d6c92233921cc46 Reviewed-on: https://code.wireshark.org/review/26504 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-03-16Update some documentation to prefer CMake.Gerald Combs1-40/+42
Change-Id: I8140edaee152ce1e9978d8df8a0f0e3dd077322e Reviewed-on: https://code.wireshark.org/review/26490 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-03-15Update some of the NSIS packaging documentation.Gerald Combs2-19/+19
Fix up some markup while we're here. Change-Id: I2299b8bec44ff08952e2f1bda3a40448e2fb55c6 Reviewed-on: https://code.wireshark.org/review/26487 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-03-06Docs: Updates for xsltproc and Asciidoctor.Gerald Combs2-16/+60
Change-Id: I3cfe2121beaab0fe09228ec277997d68fe824693 Reviewed-on: https://code.wireshark.org/review/26281 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-03-06Transition from GeoIP Legacy to MaxMindDB.Gerald Combs1-15/+8
MaxMind is discontinuing its legacy databases in April in favor of GeoIP2, which use a newer database format (MaxMind DB). The reference C library (libmaxminddb) is available under the Apache 2.0 license which isn't quite compatible with ours. Add mmdbresolve, a utility that reads IPv4 and IPv6 addresses on stdin and prints resolved information on stdout. Place it under a liberal license (MIT) so that we can keep libmaxminddb at arm's length. Add epan/maxmind_db.[ch], which spawns mmdbresolve and communicates with it via stdio. Migrate the preferences and documentation to MaxMindDB. Change the IPv4 and IPv6 asnum fields to FT_UINT32s. Change the geographic coordinate fields to FT_DOUBLEs. Bug: 10658 Change-Id: I24aeed637bea1b41d173270bda413af230f4425f Reviewed-on: https://code.wireshark.org/review/26214 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-19WSDG: Update docbook infoGraham Bloice1-1/+1
The docbook info is now in README.adoc Change-Id: Ifbc6a1803d23835d9b2b91a9fd6df34002cc3e8f Reviewed-on: https://code.wireshark.org/review/25900 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2018-02-11Switch from AsciiDoc to Asciidoctor.Gerald Combs2-7/+17
Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-07WSDG: Remove references to Windows XP and Vista.Gerald Combs1-4/+2
Change-Id: Id3945f53722b7a69afa4a62eb3cfc2f8e8193d74 Reviewed-on: https://code.wireshark.org/review/25671 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-05AsciiDoc: Convert some comments.Gerald Combs11-60/+20
Convert some passthrough XML comments left over from the DocBook → AsciiDoc conversion to AsciiDoc / Asciidoctor comments. Change-Id: Iaf44bcf0b8a3a383e735b2b4394722cbbb2bdff3 Reviewed-on: https://code.wireshark.org/review/25615 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-05More AsciiDoc → Asciidoctor updates.Gerald Combs11-124/+124
Switch from AsciiDoc's smart quotes markup to the quotes themselves. Use double curly quotes in place of singles. Switch from XML entities to their direct equivalents where we can. Switch from hex entities to decimal entities where we can't or it's not convenient. (Asciidoctor PDF doesn't yet handle hex entities). Change-Id: Iaf5ec33249e1c91b3d50b5d96251763243b72836 Reviewed-on: https://code.wireshark.org/review/25606 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-04Docs: Make our AsciiDoc markup more compatible with AsciiDoctor.Gerald Combs10-267/+267
Start using markup that is preferred by Asciidoctor but compatible with both generators. Add a missing "cpp" attribute and set a couple of Asciidoctor-specific compatibility attributes. Change-Id: Iff4c31362e4493b97a85f46db2c39b18c336536f Reviewed-on: https://code.wireshark.org/review/25600 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-12-17plugins: Remove moduleinfo.hJoão Valverde1-2/+0
Micro version bump for mate to homogenize it between CMake and autotools. The cmake macro doesn't handle the "a" suffix and it doesn't seem worth implementing. Change-Id: Ib022c6aa170623b83a9700e4fa098c60a9cddfab Reviewed-on: https://code.wireshark.org/review/24847 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-12-15plugins: Remove redundant plugin.rc.in filesJoão Valverde1-1/+1
plugin.rc is Windows specific, also add condition to reflect that. Change-Id: Ibbb7dab77dd1f277e2302c8f931218ca433f8c72 Reviewed-on: https://code.wireshark.org/review/24833 Reviewed-by: João Valverde <j@v6e.pt> Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2017-12-14Qt: Add and use qUtf8Printable.Gerald Combs1-4/+11
Qt 5.4 introduced qUtf8Printable, a convenience macro for converting QString to a UTF-8 const char *. Add a compatibility definition and start using it. Change-Id: I3cf88611b1ed1a34082cb2ba82394954e2e6c461 Reviewed-on: https://code.wireshark.org/review/24828 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-11-25Add information about pre-commit script to Developer Guide.Michael Mann1-5/+19
Bug: 9553 Change-Id: I19505c3c05585a05877e9f0db06400ebb8b33985 Reviewed-on: https://code.wireshark.org/review/24585 Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-11-17WSDG: Improve VS2015 chocolatey installGraham Bloice1-4/+9
Created an AdminDeployment.xml file for use with the chocolatey package for VS2015 Community Edition and updated the WSDG to include it. Bug: 14147 Change-Id: Id2a701067bf38874cf0bf534cca55dba9cfd30d4 Reviewed-on: https://code.wireshark.org/review/24464 Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2017-10-06Make osx-app.sh a configured file and remove Autotools targets.Gerald Combs1-4/+3
Rename osx-app.sh to osx-app.sh.in and add the version to the plugin path at configure time. Instead up updating Autotools accordingly just remove the macOS packaging targets. gf61c381b5a removed support for Autotools in osx-app.sh and if anyone wants to build macOS packages I'd prefer that they use the same toolchain as the buildbot. Change-Id: Ide5205265bf8859a85b1afab68fa8f8285952bd3 Reviewed-on: https://code.wireshark.org/review/23839 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-09-09Correct instructions for choco package for VS2015.Michael Mann1-1/+1
Bug: 14039 Change-Id: Ic19c77bb091cd8ee8f824b82463d8b4bae37f625 Reviewed-on: https://code.wireshark.org/review/23437 Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-08-28WSDG: Fix up some markup.Gerald Combs1-3/+3
Change-Id: I1484e63fd9626ed507ff0077073c944cf85e3602 Reviewed-on: https://code.wireshark.org/review/23273 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-08-23Update the AsciiDoc button macro name.Gerald Combs1-2/+2
Change the name of the button macro to "btn" in order to be compatible with AsciiDoctor. Change-Id: I673e0fe0ae7b343abeb1afba0b9b11402efdf0d6 Reviewed-on: https://code.wireshark.org/review/23187 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-08-22WSUG+WSDG: Add a typographic conventions section.Gerald Combs3-69/+48
Create a common_src directory for common guide content. Add a typographic convention section. Update some of the content accordingly. Change-Id: I4f69c0f52a985c48e07fa0628b19734ec691f74e Reviewed-on: https://code.wireshark.org/review/23131 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-08-18WSDG: More VS 2015 fixesGraham Bloice1-1/+1
Change-Id: I5f0d543032f62bd0c57c14a56771a63fe1bed3a3 Reviewed-on: https://code.wireshark.org/review/23122 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2017-08-18WSDG: Remove obsolete VS 2010 info from quick setupGraham Bloice1-37/+0
Change-Id: I767e04538d17702346e9343e136fc0ea4c2f9ec3 Reviewed-on: https://code.wireshark.org/review/23120 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2017-08-18WSDG: Update Qt installation infoGraham Bloice1-6/+10
Change-Id: I9da1c68949ac48e3e88227e9c4f4d4930dbd3268 Reviewed-on: https://code.wireshark.org/review/23119 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2017-08-18WSDG: Reference to an existing Qt versionStig Bjørlykke1-2/+2
Change-Id: Ia1c61cabf1bf3378bf993501dc1362163f33f1ed Reviewed-on: https://code.wireshark.org/review/23116 Reviewed-by: Stig Bjørlykke <stig@bjorlykke.org>
2017-08-17WSDG: More VS 2015 updates.Gerald Combs1-7/+12
Switch the Command Prompt instructions back to using the platform-specific variants. Switch back to setting WIRESHARK_BASE_DIR. Change-Id: Ie9f865e5fac1312f2eb3762e439d53ab9a038bd4 Reviewed-on: https://code.wireshark.org/review/23112 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-08-17Fix capitalization.Guy Harris1-1/+1
Change-Id: I43017bae5bc74678113377d0b4aad3d712647c5d Reviewed-on: https://code.wireshark.org/review/23099 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2017-08-16Update URL for Visual Studio Community Edition.Guy Harris1-1/+1
The old URL fetched VS 2013 when I tried it; update to a link that fetches VS 2015. Change-Id: Ib33e8f09bef51a532c986e70ae6ac5d9d1f1dabe Reviewed-on: https://code.wireshark.org/review/23094 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2017-08-04WSDG: Update the Windows docs and add a CMake section.Gerald Combs2-177/+163
Update the Windows section for Visual Studio 2015. Copy the content from README.cmake to its own WSDG section and remove README.cmake. Remove the PowerShell sections. Our required version (2.0) ships with every supported version of Windows. Remove the sed section. Change-Id: Id37c6e71bacc247a3ed1992adb1408ec13f6a187 Reviewed-on: https://code.wireshark.org/review/22940 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-05-29WSDG: trivial: fix a linkMartin Kaiser1-1/+1
Asciidoc will just create a link from a URL that appears in the text. If we want the link to appear as an address without a description, there's no need to add an empty description. We should, however, have a space behind the link to separate it from the text that follows. Change-Id: Ic01b1dbbea922d785776f1965481ed58f389e30a Reviewed-on: https://code.wireshark.org/review/21789 Reviewed-by: Martin Kaiser <wireshark@kaiser.cx> Petri-Dish: Martin Kaiser <wireshark@kaiser.cx> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-03-03WSDG: update for $XDG_CONFIG_HOMEPeter Wu1-1/+2
Since v2.1.0rc0-184-gb0b53fa593, the config directory has changed. Change-Id: Idbeb62f2393d1a4ec192da2d85e6bfb76782aeb8 Reviewed-on: https://code.wireshark.org/review/20365 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2017-03-02Docbook: Replace "OS X" with "macOS".Gerald Combs3-8/+8
Change-Id: Ic2ab4f9050c9c76349d8d872b8fc2bf9feb7827d Reviewed-on: https://code.wireshark.org/review/20325 Petri-Dish: Anders Broman <a.broman58@gmail.com> Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-02-24Developers Guide typoGraham Bloice1-1/+1
Change-Id: I125f8d9171ebdfaf7528d784e69d9768e6b1b8b7 Reviewed-on: https://code.wireshark.org/review/20262 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-20 21:05:00 +0000