aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
AgeCommit message (Collapse)AuthorFilesLines
2018-11-07Require Python 3, drop Python 2 supportPeter Wu1-16/+8
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-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 Harris1-4/+4
Change-Id: I40164b892e48dc4f484f8e24451b29c68a0da62d Reviewed-on: https://code.wireshark.org/review/30182 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-10-12Updates.Guy Harris1-12/+22
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-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-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-03WSDG: Stop recommending Cygwin.Gerald Combs1-204/+115
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-03-17NSIS: Link to Npcap.Gerald Combs1-2/+2
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 Combs1-7/+35
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-06Docs: Updates for xsltproc and Asciidoctor.Gerald Combs1-9/+46
Change-Id: I3cfe2121beaab0fe09228ec277997d68fe824693 Reviewed-on: https://code.wireshark.org/review/26281 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-11Switch from AsciiDoc to Asciidoctor.Gerald Combs1-2/+0
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-05AsciiDoc: Convert some comments.Gerald Combs1-6/+2
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 Combs1-13/+13
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 Combs1-66/+66
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-08-22WSUG+WSDG: Add a typographic conventions section.Gerald Combs1-28/+28
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-04WSDG: Update the Windows docs and add a CMake section.Gerald Combs1-119/+119
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-01-31WSDG: Update some of the NSIS text.Gerald Combs1-4/+3
Recommend v3 instead of v2. Change-Id: I13260611dd6b12372aba8938a87574cd9a8e1a47 Reviewed-on: https://code.wireshark.org/review/19880 Reviewed-by: Jaap Keuter <jaap.keuter@xs4all.nl> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2016-09-23More WSDG layout & markup fixups.Gerald Combs1-3/+3
Change-Id: I7b404be25d20c28c7dca23d57f9670236a5855c2 Reviewed-on: https://code.wireshark.org/review/17897 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-08-17Start recommending Python 3 on Windows.Gerald Combs1-9/+15
Works fine here, including git-review. Change-Id: I8580a6b266fba09c711be8984a9f17e02a9f789f Reviewed-on: https://code.wireshark.org/review/17097 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-07-05Developers Guide updatesGraham Bloice1-4/+30
Added info about debugging under Visual Studio. Updated buildbot info. Change-Id: I9a6a0a2b14e3616a35f652c99b04ee23ea642ba5 Reviewed-on: https://code.wireshark.org/review/16307 Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2016-06-08Switch some AsciiDoc replacements to attributes.Gerald Combs1-4/+4
Many of our AsciiDoc "macros" are simple string replacements. Start converting them to attributes. Update the release notes. Change-Id: I23d9ffd311f13a34c16cde3b4898b7f7bb8ba638 Reviewed-on: https://code.wireshark.org/review/15778 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-12-30Docbook: Use cyg-get for download PackagesAlexis La Goutte1-3/+3
Chocolatey don't support --source cygwin on 0.9.9.x ... https://github.com/chocolatey/choco/wiki/CommandsInstall#alternative-sources Change-Id: Ifa3f0fa0a6cbb88537c727bf64e06dce9916dbb2 Reviewed-on: https://code.wireshark.org/review/12069 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-11-22Developers Guide UpdatesGraham Bloice1-42/+43
Fix a bunch of typos. Commented out Strawberry Perl section on Windows, CMake no longer uses it. Removed commented out svn commit section. Change-Id: Ied53c1b9aed69dc2c99449ef198f69a8cba42d5e Reviewed-on: https://code.wireshark.org/review/12011 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-11-05docs: Windows CMake buildsGraham Bloice1-111/+14
Updated the WSDG Windows build instructions to use CMake. Change-Id: I5006c07e09ec6f628e8bc44006a3f1086e831a3c Reviewed-on: https://code.wireshark.org/review/11485 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Michael Mann <mmann78@netscape.net>
2015-04-14Start moving win-setup to PowerShell.Gerald Combs1-5/+7
Add win-setup.ps1, which duplicates the following tasks performed by config.nmake + Makefile.nmake + win-setup.sh: - Create the windows library directory. - Download files. - Download and unpack zip files. - Check and set current-tag.txt Don't verify applications or libraries. CMakeLists.txt does that. Update the Developer's Guide. Have POWERSHELL_COMMAND use dot sourcing instead of "-File", which appears to be a synonym for "-IgnoreTheExitStatusReturnedByThisScript". This removes our dependencies on unzip and wget and reduces our dependency on bash. Change-Id: Ia9def24acbe183d81b9d477fa42e655e4a3a6614 Reviewed-on: https://code.wireshark.org/review/7990 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-04-06Add a warning about Chocolatey's Wget package.Gerald Combs1-4/+6
Its CA certificate configuration appears to be incomplete. Recommend Cygwin's instead. Change-Id: I0e7ddbfbb2a37f2872a820442e2d185f20ef551e Reviewed-on: https://code.wireshark.org/review/7948 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-02WSUG: Chocolatey updates.Gerald Combs1-18/+59
Move PowerShell and Chocolatey to the top of the quick setup since most of the instructions now have a "Chocolatey" example. Use "choco install" instead of "cinst" to match the pages at chocolatey.org/packages. Show how to install Cygwin and Python using Chocolatey. MAC = Media Access Control (among other things). Mac = Macintosh. Change-Id: Ic6aabacdd3a86b4e8ca556cc6f3daa62c3e5986b Reviewed-on: https://code.wireshark.org/review/6924 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-02Try to clarify the PowerShell requirements.Gerald Combs1-3/+7
Change-Id: Ie4ad0388b920ba4a8483ad8af351ddbdd121a28b Reviewed-on: https://code.wireshark.org/review/6254 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-29Minor doc updates, added Windows debugging infoGraham Bloice1-29/+48
Change-Id: I7ddd6f8dead5db725c4e5f35778ce4b6f792bda9 Reviewed-on: https://code.wireshark.org/review/6096 Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2014-12-28Move Windows build to be VS2013 based using the Community EditionGraham Bloice1-350/+152
Drop references to long obsolete compilers. Added Chocolatey installer instructions for some packages. Change-Id: I416d4091b6acaa1ed0d5e586f0427708c4b2d646 Reviewed-on: https://code.wireshark.org/review/5986 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Michael Mann <mmann78@netscape.net>
2014-09-02Fix PortableApps packaging.Gerald Combs1-1/+27
Our Windows portable packaging environment has a lot of cruft which is no longer relevant. We removed support for U3 packages and the method we use to generate PortableApps packages has been deprecated for a while. Create PortableApps packages using current file formats (AppInfo v3.0) and tools. Generate the PA launcher using the PortableApps.com Launcher generator. Copy files and directories from the top level instead of using a manifest derived from the NSIS installer. The manifest is a good idea, but we should create a central manifest and use that to generate the NSIS and PortableApps packages instead of trying to parse wireshark.nsi. The new package still needs a bit of work but it installs and runs in the current version of the PA Platform. Remove the define for MAKENSIS_UNICODE. It doesn't look like we were using it. Start tearing down makefiles and scripts that we no longer use. Ping-Bug: 4191 Change-Id: Ib7173eec887d0abf69bb176a1e3f943a5a63bee4 Reviewed-on: https://code.wireshark.org/review/3962 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-14Windows: Clean up text file packaging.Gerald Combs1-88/+60
Convert textify.sh to PowerShell. Use PowerShell's built-in line ending conversion so that we don't depend on unix2dos. Only copy the help toc and text files to the staging directory. Add PowerShell to the Developer's Guide. Fixup some other content. (asn1/Makefile.inc.nmake contains a call to u2d. Hopefully that's not a problem.) Change-Id: I61a92aa54820d01015abb9ffa65815558ae31c71 Reviewed-on: https://code.wireshark.org/review/3487 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com>
2014-08-07Update the Developer's Guide for Chocolatey's Win flex-bison.Gerald Combs1-41/+41
Change-Id: Id86a00b521e112e445856251f0c242fbb7a2573b Reviewed-on: https://code.wireshark.org/review/3482 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-06-23Point the user at http://www.cygwin.com/install.html for downloads.Guy Harris1-3/+4
That page gives a bit more information. Change-Id: Id0c708ede50aa9e6c6583f6957c355a630fa7e7e Reviewed-on: https://code.wireshark.org/review/2578 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22Point to the Cygwin mirrors page.Guy Harris1-6/+12
If you choose to install from the Intertubes, you probably want to choose a nearby mirror site, rather than downloading from halfway across the world; the list of download sites in setup*.exe's UI gives no indication of where the mirror sites are, so you could end up picking one to which you have a slow Internet path. Tell the user about the list of mirror sites on the Cygwin Web site, as that list *does* give geographical locations. Change-Id: Idf035d288885ee45db7b3627af969e64270487a1 Reviewed-on: https://code.wireshark.org/review/2555 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22Remove trailing white space, copyedit, add a missing period.Guy Harris1-5/+5
Change-Id: I300d723a6f93293ebdf97c5ef6ac3e9b72c692ee Reviewed-on: https://code.wireshark.org/review/2533 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22Update to reflect current reality.Guy Harris1-15/+19
Cygwin has both 32-bit and 64-bit versions, with separate installers. Change-Id: I02b2699b9b3dbd3b3c65f7a372c6d423829f449b Reviewed-on: https://code.wireshark.org/review/2532 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-02-25Add Git+Gerrit command line instructions.Gerald Combs1-2/+3
Add a Git+Gerrit command line example to the Developer's Guide. Convert some Subversion text to Git. Skip building the Developer's Guide if we don't have a2x. Change-Id: I62e9e71eb3ffc07d8677df35b4b197f53f77b4f2 Reviewed-on: https://code.wireshark.org/review/384 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-01Convert the tools chapter to AsciiDoc.Gerald Combs1-0/+1372
Replace SVN text with Git, other mostly-minor edits. Change-Id: I41b602cc9334656dc8e5f37c33fb6cd660043d17 Reviewed-on: https://code.wireshark.org/review/69 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-03 08:26:02 +0000