aboutsummaryrefslogtreecommitdiffstats
path: root/docbook
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2014-08-07 16:56:17 -0700
committerGerald Combs <gerald@wireshark.org>2014-08-07 23:59:44 +0000
commit8a34884bf00cb64f273b52f341d7817f11e61a7b (patch)
tree9b7797569d3c044815bdd76637c095a56fa5629c /docbook
parent714fa85d85225307af42e2194e551b8087e617dd (diff)
Update the Developer's Guide for Chocolatey's Win flex-bison.
Change-Id: Id86a00b521e112e445856251f0c242fbb7a2573b Reviewed-on: https://code.wireshark.org/review/3482 Reviewed-by: Gerald Combs <gerald@wireshark.org>
Diffstat (limited to 'docbook')
-rw-r--r--docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc33
-rw-r--r--docbook/wsdg_src/WSDG_chapter_tools.asciidoc82
2 files changed, 66 insertions, 49 deletions
diff --git a/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc b/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc
index 91777bedca..07b162931c 100644
--- a/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc
@@ -129,7 +129,7 @@ QtShark project (ui/qt/QtShark.pro), however.
The default (suggested) full-package Qt installer is built with the MinGW
toolchain, which is not currently supported by Wireshark's build process on
Windows and so will not work. Instead, you will want to use the installer for
-the toolchain you are using (e.g. Qt <version> for Windows 32-bit (VS 2010,
+the toolchain you are using (e.g. Qt <version> for Windows 32-bit (VS 2013,
OpenGL) if you are using the toolchain set up by these quick-start
instructions).
====
@@ -145,7 +145,6 @@ you've added work in that version.
[[ChSetupCygwin]]
-
==== Install Cygwin
On 32-bit Windows, http://www.cygwin.com/setup-x86.exe[download the
@@ -159,11 +158,12 @@ Navigate to the required Category/Package row and, if the package
has a "Skip" item in the "New" column, click on the "Skip" item
so it shows a version number for:
+// Only used by win-setup.sh
* Archive/unzip
-* Devel/bison
+* Devel/bison (or install Win flex-bison - see Chocolatey below)
-* Devel/flex
+* Devel/flex (or install Win flex-bison - see Chocolatey below)
* Devel/git (recommended - see discussion about using Git below)
@@ -171,16 +171,19 @@ so it shows a version number for:
* Utils/dos2unix
-* Utils/patch (optional) (may be Devel/patch instead)
+* Utils/patch (only if needed) (may be Devel/patch instead)
+// Only used by win-setup.sh
* Web/wget
+// Also need: bash/sh, sed
+
You might also have to install
* Interpreters/m4
-if installing Devel/bison doesn't provide a working version of Bison; if
-m4 is missing, Bison will fail.
+if installing Devel/bison doesn't provide a working version of Bison. If
+m4 is missing bison will fail.
After clicking the Next button several times, the setup
will then download and install the selected packages (this
@@ -190,6 +193,20 @@ Why is this recommended? Cygwin's bash version is required, as no native Win32
version is available. As additional packages can easily be added, Perl and
other packages are also used.
+[[ChSetupChocolatey]]
+
+==== Optional: Install Chocolatey
+
+As an alternative to Cygwin you install some packages using
+https://chocolatey.org/[Chocolatey], a native package manager for Windows.
+Wireshark's build environment currently supports the _winflexbison_ package but
+support for more packages should appear in the future.
+
+// ...such as:
+// - Active Perl and/or StrawberryPerl
+// - Devbox-UnZip and/or 7zip and/or peazip
+// - Wget
+
[[ChSetupPython]]
==== Install Python
@@ -214,7 +231,7 @@ source tree by hand. It also makes first-time setup easy and enables the
Wireshark build process to determine your current source code revision.
There are several ways in which Git can be installed. Most packages are
-available at the URLs below or via the http://chocolatey.org/[Chocolatey package manager].
+available at the URLs below or via https://chocolatey.org/[Chocolatey].
Note that many of the GUI interfaces depend on the command line version.
===== The Official Windows Installer
diff --git a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
index 4d5bf04f71..b529192b6a 100644
--- a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
@@ -1088,29 +1088,23 @@ A native Win32 sed package can be obtained from
http://gnuwin32.sourceforge.net/[]. The
installation should be straightforward.
-[[ChToolsYacc]]
+[[ChToolsBison]]
-=== yacc (bison)
+=== Bison
-Bison is a free implementation of yacc.
+Bison is a parser generator used for some of Wireshark's file format support.
-[[ChToolsUnixYacc]]
+[[ChToolsUnixBison]]
-==== UNIX or Win32 Cygwin: bison
+==== UNIX or Cygwin: bison
-// XXX Add win flex-bison. The Chocolatey version isn't
-// ready pending a Chocolatey bug.
+Bison is available for most UNIX-like platforms and as the bison package from
+<<ChToolsCygwin,Cygwin>>. See the next section for native Windows options.
-Bison is available for most of the UNIX-like platforms
-and as the bison package from the
-<<ChToolsCygwin,Cygwin setup>>.
-
-If GNU Bison isn't already installed or
-available as a package for your platform, you can get it at:
-http://www.gnu.org/software/bison/bison.html[].
+If GNU Bison isn't already installed or available as a package for your
+platform you can get it at: http://www.gnu.org/software/bison/bison.html[].
-After correct installation, typing at the
-bash command line prompt:
+After correct installation running the following
----
$ bison --version
@@ -1127,36 +1121,38 @@ This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
----
-However, the version string may vary.
+Your version string may vary.
-[[ChToolsWin32Yacc]]
+[[ChToolsWindowsBison]]
-==== Win32 native: bison
+==== Windows Native: Win flex-bison and bison
-A native Win32 yacc/bison package can be obtained from
-http://gnuwin32.sourceforge.net/[]. The
-installation should be straightforward.
+A native Windows version of bison is available in the _winflexbison_
+https://chocolatey.org/[Chocolatey] package. Note that the executable is named
+`win_bison`.
-[[ChToolsLexx]]
+Native packages are available from other sources such as
+http://gnuwin32.sourceforge.net/packages/bison.htm[GnuWin]. They aren't
+officially supported but _should_ work.
-=== flex
+[[ChToolsFlex]]
-Flex is a free implementation of lexx.
+=== Flex
-[[ChToolsUnixLexx]]
+Flex is a lexical analyzer generator used for Wireshark's display filters, some
+file formats, and other features.
-==== UNIX or Win32 Cygwin: flex
+[[ChToolsUnixFlex]]
-Flex is available for most of the UNIX-like platforms
-and as the flex package from the
-<<ChToolsCygwin,Cygwin setup>>.
+==== UNIX or Cygwin: flex
-If GNU flex isn't already installed or
-available as a package for your platform, you can get it at
-http://www.gnu.org/software/flex/[].
+Flex is available for most UNIX-like platforms and as the flex package from
+<<ChToolsCygwin,Cygwin>>. See the next section for native Windows options.
-After correct installation, typing at the
-bash command line prompt:
+If GNU flex isn't already installed or available as a package for your platform
+you can get it at http://www.gnu.org/software/flex/[].
+
+After correct installation running the following
----
$ flex --version
@@ -1168,15 +1164,19 @@ should result in something like:
flex version 2.5.4
----
-However, the version string may vary.
+Your version string may vary.
-[[ChToolsWin32Lexx]]
+[[ChToolsWindowsFlex]]
-==== Win32 native: flex
+==== Windows Native: Win flex-bison and flex
-A native Win32 lexx/flex package can be obtained from
-http://gnuwin32.sourceforge.net/[]. The
-installation should be straightforward.
+A native Windows version of flex is available in the _winflexbison_
+https://chocolatey.org/[Chocolatey] package. Note that the executable is named
+`win_flex`.
+
+Native packages are available from other sources such as
+http://gnuwin32.sourceforge.net/packages/flex.htm[GnuWin]. They aren't
+officially supported but _should_ work.
[[ChToolsGit]]