Developers Guide Updates

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>

7 files changed, 72 insertions, 118 deletions

diff --git a/docbook/wsdg_src/WSDG_chapter_build_intro.asciidoc b/docbook/wsdg_src/WSDG_chapter_build_intro.asciidoc
index a0b9a2cf1c..9643746361 100644
--- a/docbook/wsdg_src/WSDG_chapter_build_intro.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_build_intro.asciidoc
@@ -35,10 +35,10 @@ section of the file 'doc/README.developer'.
 
 === The GLib library
 
-Glib is used as a basic platform abstraction library. It's doesn't provide
+Glib is used as a basic platform abstraction library. It doesn't provide
 any direct GUI functionality.
 
-To quote the Glib Reverence Manual:
+To quote the Glib Reference Manual:
 ____
 GLib provides the core application building blocks for libraries and
 applications written in C. It provides the core object system used in GNOME, the
diff --git a/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc b/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc
index bd7253aeb3..1930a96123 100644
--- a/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc
@@ -132,7 +132,7 @@ be called to do the actual dissecting. Then we associate the handle with a UDP
 port number so that the main program will know to call us when it gets UDP
 traffic on that port.
 
-The stardard Wireshark dissector convention is to put +proto_register_foo()+ and
+The standard Wireshark dissector convention is to put +proto_register_foo()+ and
 +proto_reg_handoff_foo()+ as the last two functions in the dissector source.
 
 Now at last we get to write some dissecting code. For the moment we'll
@@ -338,7 +338,7 @@ as +foo.type=1+ into the filter box.
 This tallies with our call above where we tell it to only look at one byte.
 
 * 'BASE_DEC' - Tor an integer type, this tells it to be printed as a decimal
-number. It could be hexdecimal (BASE_HEX) or octal (BASE_OCT) if that made more sense.
+number. It could be hexadecimal (BASE_HEX) or octal (BASE_OCT) if that made more sense.
 
 We'll ignore the rest of the structure for now.
 
@@ -975,7 +975,7 @@ exception.
 Adding a Tap interface to a protocol allows it to do some useful things.
 In particular you can produce protocol statistics from the tap interface.
 
-A tap is basically a way of allowing other items to see whats happening as
+A tap is basically a way of allowing other items to see what's happening as
 a protocol is dissected. A tap is registered with the main program, and
 then called on each dissection. Some arbitrary protocol specific data
 is provided with the routine that can be used.
diff --git a/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc b/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc
index a5518bd5b6..c2be1e29fc 100644
--- a/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc
@@ -273,7 +273,7 @@ be spent on more interesting tasks.
   be narrowed down to a few commits, making a fix much easier.
 
 * "Health status" overview of the sources. A quick look at:
-  https://buildbot.wireshark.org/trunk/[] gives a good "feeling" if the sources
+  https://buildbot.wireshark.org/wireshark-master/[] gives a good "feeling" if the sources
   are currently "well". On the other hand, if all is "red", an update of a
   personal source tree might better be done later ...
 
@@ -308,11 +308,11 @@ console logfile, to get additional information.
 The Buildbot runs on a platform collection that represents the different
 "platform specialties" quite well:
 
-* Windows 8.1 x86 (Win32, little endian, Visual Studion 2013)
+* Windows 8.1 x86 (Win32, little endian, Visual Studio 2013)
 
-* Windows 7 x86-64 (Win64, little endian, VS 2013)
+* Windows 7 x86-64 (Win64, little endian, Visual Studio 2013)
 
-* Ubuntu x86-64 (Linux, little endian, gcc)
+* Ubuntu x86-64 (Linux, little endian, gcc, Clang)
 
 * Solaris SPARC (Solaris, big endian, gcc)
 
@@ -357,7 +357,7 @@ an ongoing effort to build a protocol reference and a lot more.
 
 And best of all, if you would like to contribute your knowledge on a
 specific topic (maybe a network protocol you know well), you can edit the
-wiki pages by simply using your webbrowser.
+Wiki pages by simply using your webbrowser.
 
 [[ChIntroFAQ]]
 
@@ -456,7 +456,7 @@ someone answers your question.
 The Wireshark community collects bug reports in a Bugzilla database at
 wireshark-bugs-site:[]. This database is filled with manually filed bug reports,
 usually after some discussion on wireshark-dev, and automatic bug reports from
-the buildbot tools.
+the Buildbot tools.
 
 [[ChIntroQA]]
 
diff --git a/docbook/wsdg_src/WSDG_chapter_libraries.asciidoc b/docbook/wsdg_src/WSDG_chapter_libraries.asciidoc
index f41bfdfa0b..5e051ef022 100644
--- a/docbook/wsdg_src/WSDG_chapter_libraries.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_libraries.asciidoc
@@ -88,7 +88,7 @@ must be set appropriately.
 === Qt
 
 The Qt library is used to build the UI for Wireshark and is used to provide a
-platform independant UI.
+platform independent UI.
 For more information on the Qt libraries, see <<ChUIQt>>.
 
 [[ChLibsUnixQt]]
@@ -101,7 +101,7 @@ TBD.
 
 ==== Win32 MSVC
 
-Qt5 must be installed maunally, from the Qt installers page
+Qt5 must be installed manually, from the Qt installers page
 http://www.qt.io/download-open-source/#section-2[], using the version of Qt
 appropriate for your compiler.  Note that separate installations (into different directories) of Qt
 are required for 32 bit and 64 bit builds.  The environment variable QT5_BASE_DIR should be
diff --git a/docbook/wsdg_src/WSDG_chapter_sources.asciidoc b/docbook/wsdg_src/WSDG_chapter_sources.asciidoc
index a965180f2d..195c63bf50 100644
--- a/docbook/wsdg_src/WSDG_chapter_sources.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_sources.asciidoc
@@ -32,7 +32,7 @@ Wireshark source code. The code is stored inside Wireshark project's Git
 repository located at a server at the wireshark.org domain.
 
 Changes to the official repository are managed using the
-https://code.google.com/p/gerrit/[Gerrit] code review sytem. Gerrit
+https://code.google.com/p/gerrit/[Gerrit] code review system. Gerrit
 makes it easy to test and discuss changes before they are
 pushed to the main repository. For an overview of Gerrit see the
 https://code.wireshark.org/review/Documentation/intro-quick.html[Quick
@@ -49,7 +49,7 @@ Gerrit makes it easy to contribute. You can sign in with any OpenID
 provider and push your changes. It's usable from both the web and
 command line and is integrated with many popular tools.
 
-.Git is our *third* revision conrol system
+.Git is our *third* revision control system
 [NOTE]
 ====
 Wireshark originally used http://www.nongnu.org/cvs/[Concurrent Versions System]
@@ -81,7 +81,7 @@ https://code.wireshark.org/review/gitweb?p=wireshark.git
 
 Like most revision control systems, Git uses
 http://en.wikipedia.org/wiki/Branching_%28revision_control%29[branching] to
-manange different copies of the source code and allow parallel development.
+manage different copies of the source code and allow parallel development.
 Wireshark uses the following branches for official releases:
 
 * 'master': Main feature development and odd-numbered "feature" releases.
@@ -258,13 +258,13 @@ possible (e.g. because of a restrictive firewall).
 
 Age: some number of minutes (a bit older than the Git access).
 
-The buildbot server will automatically start to generate a snapshot of
+The Buildbot server will automatically start to generate a snapshot of
 Wireshark's source tree after a source code change is committed.
 These snapshots can be found at wireshark-snapshots-url:[].
 
 If Git access isn't possible, e.g. if the connection to the server
 isn't possible because of a corporate firewall, the sources can be
-obtained by downloading the buildbot snapshots. However, if you are
+obtained by downloading the Buildbot snapshots. However, if you are
 going to maintain your sources in parallel to the "official" sources
 for some time, it's recommended to use the anonymous (or authenticated)
 Git access if possible (believe it, it will save you a lot of time).
@@ -297,7 +297,7 @@ you might want to keep them in sync with the sources at the upstream
 Git repository.
 
 [TIP]
-.Take a look at the buildbot first
+.Take a look at the Buildbot first
 ====
 As development evolves, the Wireshark sources are compilable
 most of the time -- but not always. You should take a look at
@@ -422,7 +422,7 @@ installed version first.
 
 After a successful build you can run Wireshark right from the build
 directory. Still the program would need to know that it's being run from
-the build directory and not from its install location. This has inpact
+the build directory and not from its install location. This has an impact
 on the directories where the program can find the other parts and
 relevant data files.
 
@@ -431,7 +431,7 @@ In order to run the Wireshark from the build directory set the environment
 variable `WIRESHARK_RUN_FROM_BUILD_DIRECTORY` and run
 Wireshark. If your platform is properly setup, your build directory and
 current working directory are not in your PATH, so the
-commandline to launch Wireshark would be:
+command line to launch Wireshark would be:
 
 ----
 $ WIRESHARK_RUN_FROM_BUILD_DIRECTORY=1 ./wireshark
@@ -502,7 +502,7 @@ on using the <<ChToolsDebugger, Debugger Tools>>.
 
 As the Wireshark developers are working on many different platforms, a lot of
 editors are used to develop Wireshark (emacs, vi, Microsoft Visual Studio
-and many many others). There's no "standard" or "default" development
+and many, many others). There's no "standard" or "default" development
 environment.
 
 There are several reasons why you might want to change the Wireshark
@@ -639,7 +639,7 @@ as described at <<ChSrcGit>>.
 //
 // If you've added a new file, e.g.
 // 'packet-myprotocol.c', you can use `svn add` to add it to your local tree before generating the patch.
-// Similarly, you can use `svn rm` for files that shouldbe removed.
+// Similarly, you can use `svn rm` for files that should be removed.
 
 [[ChSrcSVNGUIDiff]]
 
@@ -794,14 +794,14 @@ be rejected.
 
 * 'Submit dissectors as built-in whenever possible.' Developing a new dissector
 as a plugin is a good idea because compiling and testing is quicker, but it's
-best to convert dissectors to the built-in style before submitting for checkin.
+best to convert dissectors to the built-in style before submitting for check in.
 This reduces the number of files that must be installed with Wireshark and
 ensures your dissector will be available on all platforms.
 +
 This is no hard-and-fast rule though. Many dissectors are straightforward so they
 can easily be put into "the big pile", while some are ASN.1 based which takes a
-different approach, and some multiple sourcefile dissectors are more suitable to
-be placed separate as plugin.
+different approach, and some multiple source file dissectors are more suitable to
+be placed separately as plugins.
 
 * 'Verify that your dissector code does not use prohibited or deprecated APIs.'
   This can be done as follows:
@@ -974,53 +974,6 @@ It is preferred that people *not* submit patches like
 that, especially if they're only patching files that exist in multiple
 directories such as 'Makefile.am'.
 
-[[ChSrcAdd]]
-
-// Rewrite for Git ?
-// === Add a new file to the Subversion repository
-//
-// The recommended way to commit new files is described in <<ChSrcContribute>>.
-// However, the following might be of interest for contributing developers as well.
-//
-// [NOTE]
-// ====
-// These actions can only be performed by the Wireshark core developers who
-// have write access to the Subversion repository. It is put in here to have
-// all information in one place.
-// ====
-//
-// If you (as a core developer) need to add a file to the SVN repository,
-// then you need to perform the following steps:
-//
-// . Verify that that file is complete (has Wireshark boilerplate, `$Id$`, etc).
-//
-// . Add the new file(s) to the repository:
-// +
-// ----
-// $ svn add new_file
-// ----
-//
-// . Set the line ending property to 'native' for the new file(s):
-// +
-// ----
-// $ svn propset svn:eol-style native new_file
-// ----
-//
-// . Set version keyword to 'Id' for the new file(s):
-// +
-// ----
-// $ svn propset svn:keywords Id new_file
-// ----
-//
-// . Commit your changes, including the added file(s).
-// +
-// ----
-// $ svn commit new_file other_files_you_modified
-// ----
-//
-// Don't forget a brief description of the reason for the commit so other
-// developers don't need to read the diff in order to know what has changed.
-
 [[ChSrcBinary]]
 
 === Binary packaging
diff --git a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
index 65180a3d3f..3ee2ec471a 100644
--- a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
@@ -620,7 +620,8 @@ menu and then click on the required line and press F9.  To run the program,
 press F5.
 
 If you require a non-optimised version, then build using a debug configuration, e.g.
-`msbuild /m /p:Configuration=RelWithDebInfo Wireshark.sln`.
+`msbuild /m /p:Configuration=Debug Wireshark.sln`.  The build products will be found
+in C:\Development\wsbuild32\run\RelWithDebInfo\.
 
 [[ChToolsBash]]
 
@@ -758,47 +759,47 @@ Internet, point your browser at http://www.perl.com/, the Perl Home Page.
 
 However, the version string may vary.
 
-[[ChToolsWindowsPerl]]
-
-==== Windows native: Perl
-
-A native Windows Perl package can be obtained from
-http://www.ActiveState.com[Active State] or http://strawberryperl.com/[Strawberry Perl]. The installation
-should be straightforward.
-
-You may also use Chocolatey to install either package:
-
-----
-PS:\> choco install ActivePerl
-----
-
-or
-
-----
-PS:\> choco install StrawberryPerl
-----
-
-After correct installation, typing at the command
-line prompt (cmd.exe):
-
-----
-> perl -v
-----
-
-should result in something like:
-
-----
-This is perl, v5.8.0 built for MSWin32-x86-multi-thread
-(with 1 registered patch, see perl -V for more detail)
-
-Copyright 1987-2002, Larry Wall
-
-Binary build 805 provided by ActiveState Corp. http://www.ActiveState.com
-Built 18:08:02 Feb  4 2003
-...
-----
-
-However, the version string may vary.
+//[[ChToolsWindowsPerl]]
+//
+//==== Windows native: Perl
+//
+//A native Windows Perl package can be obtained from
+//http://www.ActiveState.com[Active State] or http://strawberryperl.com/[Strawberry Perl]. The installation
+//should be straightforward.
+//
+//You may also use Chocolatey to install either package:
+//
+//----
+//PS:\> choco install ActivePerl
+//----
+//
+//or
+//
+//----
+//PS:\> choco install StrawberryPerl
+//----
+//
+//After correct installation, typing at the command
+//line prompt (cmd.exe):
+//
+//----
+//> perl -v
+//----
+//
+//should result in something like:
+//
+//----
+//This is perl, v5.8.0 built for MSWin32-x86-multi-thread
+//(with 1 registered patch, see perl -V for more detail)
+//
+//Copyright 1987-2002, Larry Wall
+//
+//Binary build 805 provided by ActiveState Corp. http://www.ActiveState.com
+//Built 18:08:02 Feb  4 2003
+//...
+//----
+//
+//However, the version string may vary.
 
 [[ChToolsSed]]
 
diff --git a/docbook/wsdg_src/WSDG_chapter_userinterface.asciidoc b/docbook/wsdg_src/WSDG_chapter_userinterface.asciidoc
index 33a5a0f555..a62412a780 100644
--- a/docbook/wsdg_src/WSDG_chapter_userinterface.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_userinterface.asciidoc
@@ -1,7 +1,7 @@
 ++++++++++++++++++++++++++++++++++++++
 <!-- WSDG Chapter User Interface -->
 ++++++++++++++++++++++++++++++++++++++
-    
+
 [[ChapterUserInterface]]
 
 == User Interface
@@ -66,7 +66,7 @@ name components with underscores. For example, ColoringRulesDialog is defined in
 'coloring_rules_dialog.ui'.
 
 General-purpose dialogs are subclasses of `QDialog`. Dialogs that rely on the
-current capture file can sublcass `WiresharkDialog`, which provides methods and
+current capture file can subclass `WiresharkDialog`, which provides methods and
 members that make it easier to access the capture file and to keep the dialog
 open when the capture file closes.
 
@@ -154,7 +154,7 @@ automatically retranslated and must instead be manually translated using
 of this.
 
 NOTE: If your object life is short and your components are (re)created
-dynamically then it is ok to to use `tr()`.
+dynamically then it is ok to use `tr()`.
 
 In most cases you should handle the changeEvent in order to catch
 `QEvent::LanguageChange`.