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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Gerald Combs