aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2018-05-14 23:53:34 -0700
committerGuy Harris <guy@alum.mit.edu>2018-05-15 06:54:08 +0000
commit30ae3847e008def30f0c9913b3d938e82ff1c9a2 (patch)
tree3b450723aee2ac5d2a10e7db7b9f50ecd89d819b
parent81bfa3f7b84b708f87ac57f97afb472a0518784a (diff)
Mention how to get Ninja, and speak more of UNIX and UNIX-like platforms.
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>
-rw-r--r--docbook/wsdg_src/WSDG_chapter_tools.asciidoc55
1 files changed, 36 insertions, 19 deletions
diff --git a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
index 641df262cf..736110ca87 100644
--- a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
@@ -16,9 +16,9 @@ Most of these tools have their roots on UNIX or UNIX-like platforms such
as Linux, but Windows ports are also available. Therefore the tools are
available in different "flavours":
-* UNIX: The tools should be commonly available on the supported UNIX
- platforms and for Windows platforms by using an emulation layer such
- as Cygwin.
+* UNIX and UNIX-like platforms: The tools should be commonly available
+ on the supported UNIX and UNIX-like platforms and for Windows
+ platforms by using an emulation layer such as Cygwin.
* Windows native: Some tools are available as native Windows tools, no
special emulation is required. Many of these tools can be installed
(and updated) using http://chocolatey.org[Chocolatey], a Windows
@@ -97,14 +97,14 @@ case.
=== CMake
-Wireshark’s build environment can be configured using CMake on Windo
-and various UN*Xes, including Linux, macOS, and *BSD. CMake is designed
-to support out of tree builds. So much so, that in tree builds do not
-work properly in all cases. Along with being cross-platform, CMake
-supports many build tools and environments including traditional make,
-Ninja, and MSBuild. Our Buildbot runs CMake steps on Ubuntu, Win32,
-Win64, and macOS. In particular, the macOS and Windows packages are
-built using CMake.
+Wireshark’s build environment can be configured using CMake on various
+UNIX-like platforms, including Linux, macOS, and *BSD, and on Windows.
+CMake is designed to support out-of-tree builds - so much so that
+in-tree builds do not work properly in all cases. Along with being
+cross-platform, CMake supports many build tools and environments
+including traditional make, Ninja, and MSBuild. Our Buildbot runs
+CMake steps on Ubuntu, Win32, Win64, and macOS. In particular, the
+macOS and Windows packages are built using CMake.
Building with CMake typically includes creating a build directory and
specifying a *generator*, aka a build tool. For example, to build
@@ -178,7 +178,7 @@ Frequently Asked Questions: http://www.cmake.org/Wiki/CMake_FAQ
[[ChToolsGNUChain]]
-=== GNU compiler toolchain (UNIX only)
+=== GNU compiler toolchain (UNIX and UNIX-like platforms only)
[[ChToolsGCC]]
@@ -303,6 +303,23 @@ Your version string may vary, of course.
[[ChToolsMSChain]]
+==== Ninja
+
+Ninja is an alternative to make, and is available for many of the
+UNIX-like platforms. It runs builds faster than make does.
+
+It is designed to have its build files generated by tools such as CMake;
+to generate build files for Ninja, run CMake with the `-G Ninja` flag.
+
+If Ninja isn't already installed, see the list of suggestions for Ninja
+packages at:
+https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages.
+
+If Ninja isn't already installed and isn't
+available as a package for your platform, you can get it from:
+https://ninja-build.org. You can download the source code or binaries
+for Linux, macOS, and Windows (we have not tested Ninja on Windows).
+
=== Microsoft compiler toolchain (Windows native)
To compile Wireshark on Windows using the Microsoft C/{cpp}
@@ -703,7 +720,7 @@ The bash shell is needed to run several shell scripts.
[[ChToolsGNUBash]]
-==== UNIX: GNU Bash
+==== UNIX and UNIX-like platforms: GNU Bash
Bash (the GNU Bourne-Again SHell) is available for most UNIX and
UNIX-like platforms. If it isn't already installed or available as a
@@ -762,7 +779,7 @@ default. You can verify your Python version by running
$ python --version
----
-on UNIX and Linux and
+on UNIX-like platforms and
[source,cmd]
----
@@ -795,7 +812,7 @@ and above should work fine.
[[ChToolsUnixPerl]]
-==== UNIX: Perl
+==== UNIX and UNIX-like platforms: Perl
Perl is available for most UNIX and UNIX-like platforms. If perl isn't
already installed or available as a package for your platform, you can
@@ -880,7 +897,7 @@ Bison is a parser generator used for some of Wireshark’s file format support.
[[ChToolsUnixBison]]
-==== UNIX: Bison
+==== UNIX and UNIX-like platforms: Bison
Bison is available for most UNIX and UNIX-like platforms. See the next
section for native Windows options.
@@ -929,7 +946,7 @@ file formats, and other features.
[[ChToolsUnixFlex]]
-==== UNIX: flex
+==== UNIX and UNIX-like platforms: flex
Flex is available for most UNIX and UNIX-like platforms. See the next
section for native Windows options.
@@ -987,7 +1004,7 @@ client.
[[ChToolsUnixGit]]
-==== UNIX: git
+==== UNIX and UNIX-like platforms: git
Git is available for most UNIX and UNIX-like platforms. If Git isn't
already installed or available as a package for your platform, you can
@@ -1077,7 +1094,7 @@ tool.
[[ChToolsUnixPatch]]
-==== UNIX: patch
+==== UNIX and UNIX-like platforms: patch
Patch is available for most UNIX and UNIX-like platforms. If GNU patch
isn't already installed or available as a package for your platform, you