Move some text from README.qt to the Developer's Guide. Add an overview.
Change-Id: Ia20ed837939e34871b157566c38cd0c6e590bc38
Reviewed-on: https://code.wireshark.org/review/7087
Reviewed-by: Gerald Combs <gerald@wireshark.org>
We tend to clobber the reader with admon blocks. Make the preceding and
succeeding ones normal paragraphs.
Change-Id: I0c70af93feb586d2e8f6120e2842fab52379b76f
Reviewed-on: https://code.wireshark.org/review/6970
Reviewed-by: Gerald Combs <gerald@wireshark.org>
from building as well as a hint about downloading the vcredist_xYY.exe file.
Change-Id: I6ae9a045939a77ba2c9584f05124fdc8f355f11c
Signed-off-by: Richard Sharpe <realrichardsharpe@gmail.com>
Reviewed-on: https://code.wireshark.org/review/6916
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
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>
Further removal of older style build environment.
Change-Id: I499ba50f55620ad627de3dc4316051985d00a7f5
Reviewed-on: https://code.wireshark.org/review/6918
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
Added comment about VS2013 being the preferred option.
Added instructions for Win32.Mak.
Change-Id: Ic2cca5123c471d9a806d0f4a387f82ad30ace9f6
Reviewed-on: https://code.wireshark.org/review/6886
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
Corrected info about paths to built executable.
Cross referenced empty debugger sections to the section with info.
Change-Id: I4366825990f1a5286c7292c9f00e540160c1b5d0
Reviewed-on: https://code.wireshark.org/review/6520
Reviewed-by: Michael Mann <mmann78@netscape.net>
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
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>
Move the idl2wrs section to the Developer's Guide. Leave most of the
other content intact for now.
Change-Id: I98c6eeab62af5cc55e3ce23ab1107df02b1a22cf
Reviewed-on: https://code.wireshark.org/review/5214
Reviewed-by: Gerald Combs <gerald@wireshark.org>
documents referring to the split out sections.
Remove trailing whitespace while at this.
Change-Id: I36cfe0ac55e8f653bffbf850e01f582aacf85557
Reviewed-on: https://code.wireshark.org/review/4094
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
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>
instructions for building QtShark; note alternate cygwin package for
'patch' utility; update example setup script to add Qt bin directory to PATH,
and extract out paths as variables.
Change-Id: Id404b8757dbfd0dc1119b89e01bbe2fa139e2b38
Reviewed-on: https://code.wireshark.org/review/2751
Reviewed-by: Evan Huus <eapache@gmail.com>
Reviewed-by: Anders Broman <a.broman58@gmail.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>
Add developer-guide-docinfo.xml, which lets us carry over DocBook front
matter. Remove the meta_info chapter. Most of its contents are now in
developer-guide-docinfo.xml. Add a DocBook revision history based on
hints from the Git/SVN/CVS revision history.
Comment out or note makefile content that's no longer necessary for
converting the Developer's Guide but will be useful for converting the
User's Guide. Fix building the release notes with CMake. Other minor
changes. Tested with Autotools, nmake, and CMake.
Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a
Reviewed-on: https://code.wireshark.org/review/155
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
Add some docbook-related entries to .gitignore. Whoever maintains the
Windows libraries has done a terrible job of keeping this chapter up to
date.
Change-Id: Ic6dcbd9e8369eae9f07403bd3f805a515886f542
Reviewed-on: https://code.wireshark.org/review/72
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
chapter (WSDG_chapter_sources) has been converted.
Conversion was done using the script in
https://code.wireshark.org/review/#/c/9/ along with manual cleanup.
Changes are mostly limited formatting.
It's helpful to have a copy of the pre-conversion guide for comparison.
I've placed a chunked copy online at
http://www.wireshark.org/~gerald/wsdg_html_2014_01/ .
Tested under Autotools. Nmake and CMake will likely break. I'll take a
look shortly. If only we had documention adding a feature branch to
Gerrit and using it to test different platforms...
svn path=/trunk/; revision=54945
just define WS_DLL_PUBLIC_NOEXTERN inside the ifdefs, and define
WS_DLL_PUBLIC as WS_DLL_PUBLIC_NOEXTERN followed by "extern".
Then rename WS_DLL_PUBLIC_NOEXTERN to WS_DLL_PUBLIC_DEF, to clarify that
it's what should be used for definitions; at least on Windows, you
*have* to use it when declaring arrays without a size, and, whilst you
might be able to use WS_DLL_PUBLIC for definitions of functions and
perhaps data definitions other than no-size arrays, it might be clearer
to rename WS_DLL_PUBLIC to WS_DLL_PUBLIC_DECL and use it only for
declarations.
svn path=/trunk/; revision=50334
cramming a bunch of text into a bunch of narrow columns. Remove the
.NET framework 2.0 SDK and Visual Studio 2005. Sort items from newest to
oldest.
svn path=/trunk/; revision=49892
When pointing people to the mailing lists, point them directly to the lists
page rather than explaining where to look for the link on the main page (the
directions were several years out of date).
While there also fix up some of the indentation and add a link to the Q&A site
in the developer's guide.
svn path=/trunk/; revision=49553
- add it as an optional package to install when installing Cygwin
- de-duplicate some text about why it's good to work with the Subversion
source (no need to tell them the same thing, once for each Subversion
client)
- Make it obvious that the user has a choice of Subversion clients
- Fix the URL to TortoiseSVN
svn path=/trunk/; revision=46016
with Visual Studio Express Edition - the resulting package cannot be
self-contained and will require that the Visual C++ Redistributables be
installed on any machine into which you plug the portable Wireshark
package, which kinda defeats the purpose of a portable package (plug it
in and go).
svn path=/trunk/; revision=45315
and vcredist_{processor}.exe into three paragraphs, and put the bit
about vcredist_{64-bit processor}.exe into the paragraph about 64-bit
targets.
svn path=/trunk/; revision=45311
*all* 64-bit builds, regardless of whether you have Visual Studio Express
Edition or not.
You only need to download the redistributable package when you're using
the Express Edition or are doing 64-bit builds.
svn path=/trunk/; revision=45307
MSVC2008 and MSVC2010, when doing 32-bit builds, with the non-Express
versions we "Install a particular Visual C++ assembly as a private
assembly for the application", if for no other reason than to support
"portable" versions of Wireshark, where the application is provided a a
completely self-contained directory tree on a medium such as a flash
drive, and where there is no installer to install anything on the target
machine. For 64-bit builds, we currently don't support a "portable"
version, so we "Use the Visual C++ Redistributable Package".
Convert tabs to spaces.
svn path=/trunk/; revision=45306
the versions of vcredist, just in case anybody is building for Itanium.
The second time we mention them, mention all three, not just the 32-bit
x86 version. Rewrite the sentence for that a bit - it's not as if MSVC
uses particular deployment methods, those were chosen by the Wireshark
development team.
For VS 2008, note that Microsoft mentions all three redistribution
mechanisms, and link to the "Choosing a Deployment Method" page for VS
2008 (which looks as if Microsoft didn't do a good job of editing it
after copying-and-pasting the 2005 version, or didn't set up ASP or
whatever it is that supplies VS-specific versions of the pages
correctly).
For VS 2010, note that Microsoft mentions all three redistribution
mechanisms, link to the "Choosing a Deployment Method" page for VS 2010,
and note that it recommends the method we chose and gives it as as the
first method.
svn path=/trunk/; revision=45302
tags from the "Redistributing Visual C++ libraries" section of the MSDN
"Choosing a Deployment Method" page, and put them in the same order as
the three methods mentioned on that page (which means swapping the
second and third ways in the list, so "method 2" becomes "method 3" and
"method 3" becomes "method 2".
svn path=/trunk/; revision=45301
paragraphs give more details on how to install, and the stuff about
vcvars32.bat is given later, in more detail.
While we're at it, fix another reference to vcvars32 to also refer to
vcvarsall.
svn path=/trunk/; revision=45278
the "32-bit vs. 64-bit build machine" vs. "32-bit vs. 64-bit target"
matrix. Use the correct paths ("Visual Studio 10.0", not "Visual Studio
10" - an MSDN page uses the latter, but my virtual machine shows the
former; add "(x86)" to "Program Files" on 64-bit machines, as the batch
files are installed in 32-bitland).
svn path=/trunk/; revision=45276
Refer to the SDK as just the SDK, not the Platform SDK - Microsoft
dropped the "Platform" with the Vista SDK.
Update the section on the SDK to reflect that and to reflect that Vista
isn't the current version.
svn path=/trunk/; revision=45077
Remove "/en-us" from links; presumably it'll go to the appropriate
country and language for you (or will default to the country and primary
language of Redmond, Washington :-)).
svn path=/trunk/; revision=43034
"id=" links when I last tried them).
There are apparently both x86 and x86 versions of the VC++ 2005
distributables and, at least for the non-SP1 versions, there's also an
IA64 version. List them.
If the URLs have the country and language in them, the displaylang= item
doesn't seem to work (tried with both "displaylang=en" and
"displaylang=de" with both "en-us" and "de-de"). Remove it.
Fix some typoes.
svn path=/trunk/; revision=43026
Add version numbers for MSVC++ 2010 64-bit redistributables.
--Cette ligne, et les suivantes ci-dessous, seront ignorées--
M docbook/wsdg_src/WSDG_chapter_tools.xml
svn path=/trunk/; revision=43018
discussing VC++ 2010, at least, you may need *both* of them if you'll be
doing both 32-bit and 64-bit builds; hopefully this makes it sound a bit
less like a choice of one or the other but not both.
Get rid of reference to 32-bit builds with MSVC++ 2008 (did it do 64-bit
builds? I didn't see any reference to 64-bit redistributables for it on
the pages for the other redistributables).
svn path=/trunk/; revision=43014
to the WIRESHARK_LIB_DIR, and don't run it after downloading it).
Indicate that the version of vcredist_x86.exe you download depends not
only on the major version of the VC++ you have but on what service packs
you have.
svn path=/trunk/; revision=43010
keys to have _uint in their names, to match the routines that handle
dissector tables with string keys. (Using _port can confuse people into
thinking they're intended solely for use with TCP/UDP/etc. ports when,
in fact, they work better for things such as Ethernet types, where the
binding of particular values to particular protocols are a lot
stronger.)
svn path=/trunk/; revision=35224
As the book says:
"Often a program listing will include tab characters to indent lines of code.
When such a listing is imported to DocBook XML and formatted, the tab
characters are not expanded as they are in the program editor.
That's because in XSL-FO and HTML, tab stops and tab expansion are not
described in either HTML or XSL-FO standards.
By default, an XSL-FO processor treats a tab character as a single space,
which leads to unsatisfactory results."
http://www.sagehill.net/docbookxsl/TabExpansion.html
svn path=/trunk/; revision=35215
https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3437 :
PSDK is now required when building with MSVC6.
From me: change some spacing around to make the table
in section 4.4.1 more readable in PDF form.
svn path=/trunk/; revision=32292
(from me): Change a few additional cases of "2008EE" to "2008EE SP1"
and indicate that 2008EE SP1 is recommended (rather than 2005EE).
svn path=/trunk/; revision=31797