Commit graph

234 commits

Author SHA1 Message Date
Graham Bloice
36aca292fb Minor Development Guide updates
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>
2015-01-14 10:36:50 +00:00
Michael Mann
d296c75247 Some more random removal of ep_ memory.
Change-Id: I6eccd20280e907bd9e6a5fcf873ccf80afddecac
Reviewed-on: https://code.wireshark.org/review/6416
Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-01-09 05:54:38 +00:00
Gerald Combs
970e7c1921 Try to clarify the PowerShell requirements.
Change-Id: Ie4ad0388b920ba4a8483ad8af351ddbdd121a28b
Reviewed-on: https://code.wireshark.org/review/6254
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-02 20:52:22 +00:00
Graham Bloice
5f2b99819b Minor doc updates, added Windows debugging info
Change-Id: I7ddd6f8dead5db725c4e5f35778ce4b6f792bda9
Reviewed-on: https://code.wireshark.org/review/6096
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>
2014-12-29 11:32:57 +00:00
Graham Bloice
15a9f5dd70 Move Windows build to be VS2013 based using the Community Edition
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>
2014-12-28 17:08:31 +00:00
Gerald Combs
3924310d86 WSUG: Convert ``Command Line Tools'' to AsciiDoc.
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>
2014-11-09 19:41:44 +00:00
Gerald Combs
8b7d27c8be WSDG: Update the Windows Qt download text.
Change-Id: I6fd027ff76b5b463f33992898965a3e037778071
Reviewed-on: https://code.wireshark.org/review/4443
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-10-03 15:54:05 +00:00
Gerald Combs
cbe7741926 Update the documentation to use "Wireshark.pro".
Change-Id: I024a882030e489cbd273a4245b0cd3be656f060f
Reviewed-on: https://code.wireshark.org/review/4191
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-19 15:46:43 +00:00
Gerald Combs
71bb17102e Update the docbook directory to use https://www.wireshark.org.
Change-Id: Ied91158cb055b0235b4a5106c3eb6b9300997c32
Reviewed-on: https://code.wireshark.org/review/4141
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-17 00:17:09 +00:00
Joerg Mayer
6a7414f726 README.dissector was split from README.developer in 2013 - update some
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>
2014-09-13 05:34:39 +00:00
Gerald Combs
85eec7f603 Fix PortableApps packaging.
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>
2014-09-02 23:55:54 +00:00
Gerald Combs
673247f04f Windows: Clean up text file packaging.
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>
2014-08-14 10:26:31 +00:00
Eugene Sukhodolin
9deb769096 Minor typo corrections
Change-Id: I5962ba6a9b9285095ddacf00307a3094c697461a
Reviewed-on: https://code.wireshark.org/review/3546
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-08-11 06:37:56 +00:00
Gerald Combs
8a34884bf0 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>
2014-08-07 23:59:44 +00:00
Gerald Combs
700a474d3b Start converting the User's Guide to AsciiDoc.
Convert the preface and introduction. Update various makefiles.

Change-Id: Id998cabadb6de458f04b7a43bdba4f98e4edb052
Reviewed-on: https://code.wireshark.org/review/3139
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-07-21 15:31:16 +00:00
Joerg Mayer
87895d7d0e Remove some $Id$ lines
Change-Id: Idec3769750f5a433b184e6e9fb44cbad23a29c60
Reviewed-on: https://code.wireshark.org/review/3023
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-07-12 14:31:51 +00:00
Tim Furlong
09839e3a6a Update WSDG win32/win64 quick start guide to include dependencies and
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>
2014-07-02 06:08:39 +00:00
Guy Harris
9fe540c35b dos2unix is now in Utils, not Base.
Change-Id: Ib430582270a2b788843785fd5aa7148ebe0f8871
Reviewed-on: https://code.wireshark.org/review/2597
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-24 00:55:55 +00:00
Guy Harris
858c48acc6 Point the user at http://www.cygwin.com/install.html for downloads.
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>
2014-06-23 17:04:58 +00:00
Guy Harris
d51faaaee7 Point to the Cygwin mirrors page.
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>
2014-06-22 18:39:12 +00:00
Guy Harris
a59d62ef2d 64-bit Cygwin's dependencies for Bison are wrong; it doesn't require m4.
Change-Id: Id6a6c0a7c09ed1d9eb1e1d522930e3f94e7b20d6
Reviewed-on: https://code.wireshark.org/review/2554
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22 18:32:36 +00:00
Guy Harris
c935411f9b Remove trailing white space, copyedit, add a missing period.
Change-Id: I300d723a6f93293ebdf97c5ef6ac3e9b72c692ee
Reviewed-on: https://code.wireshark.org/review/2533
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22 02:53:50 +00:00
Guy Harris
e088923059 Update to reflect current reality.
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>
2014-06-22 02:51:11 +00:00
Sean O. Stalley
a53cd45483 Fixed typo in docbook (usuall to usually)
Change-Id: I1aad1d6487cb6acd52bb851c08d9c4965bbb9f55
Reviewed-on: https://code.wireshark.org/review/1449
Reviewed-by: Evan Huus <eapache@gmail.com>
2014-05-01 03:03:25 +00:00
Bill Meier
faec7514cf SVN --> GIT in a few places. Fixes Bug #10060.
Change-Id: I5dcf7699e295dcdbd1e870af5ec68b010a63bf6f
Reviewed-on: https://code.wireshark.org/review/1434
Reviewed-by: Bill Meier <wmeier@newsguy.com>
2014-04-30 03:28:33 +00:00
Bill Meier
b84ce5ca43 Comment out a section re SVN usage; svn ==> git in a few cases; Fix some typos.
Change-Id: I0bd7a7d4bdcc566af6b8f672a25fb937176fde21
Reviewed-on: https://code.wireshark.org/review/1060
Reviewed-by: Bill Meier <wmeier@newsguy.com>
Tested-by: Bill Meier <wmeier@newsguy.com>
2014-04-10 18:00:07 +00:00
Gerald Combs
0a4993500b Add a backporting chapter.
Change-Id: Id0e017b18e95d6703e166fa09f767200d8ed1f8d
Reviewed-on: https://code.wireshark.org/review/925
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-04-02 23:08:57 +00:00
Joerg Mayer
5f508e8b29 Small updates to the setup process documentation
Change-Id: Ie6dc3a8254e30495945155f058f1ef10a75c4745
Reviewed-on: https://code.wireshark.org/review/700
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-03-16 19:01:25 +00:00
Gerald Combs
d75d5a197e Fix indentation and numbering.
Change-Id: Ic1b528db9128420e106affcc8b3639d2d5fc65c0
Reviewed-on: https://code.wireshark.org/review/397
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-25 23:42:01 +00:00
Gerald Combs
621a9c5023 Add back an anchor removed in gc55c57a.
Change-Id: I9795278b759d1a965abd9b22dc023c70fce19b77
Reviewed-on: https://code.wireshark.org/review/391
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-25 21:58:20 +00:00
Gerald Combs
c55c57ad72 Add Git+Gerrit command line instructions.
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>
2014-02-25 20:26:50 +00:00
Jeff Morriss
cd02def632 Clean up some more subversion references in the documentation.
Change-Id: Id6cf1a617bff3e09e47933a69d505393502874d1
Reviewed-on: https://code.wireshark.org/review/370
Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
Reviewed-by: Evan Huus <eapache@gmail.com>
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-02-25 18:04:55 +00:00
Gerald Combs
5e3113e7c9 Finish converting the Developer's Guide to AsciiDoc.
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>
2014-02-11 18:04:45 +00:00
Gerald Combs
1dc06a2681 Convert the user interface chapter to AsciiDoc.
Start mentioning Qt. Update and add HIG links.

Change-Id: Iac984045b03a96862981d58ff63c9ee6bcdbbce8
Reviewed-on: https://code.wireshark.org/review/127
Tested-by: Wireshark Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-06 20:59:00 +00:00
Gerald Combs
4dd6451a91 Convert the dissection chapter to AsciiDoc.
Change-Id: Ieccd2ad235576b9ec6013ddb23a8373ccf2f8cdf
Reviewed-on: https://code.wireshark.org/review/92
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-03 18:32:32 +00:00
Gerald Combs
1b2145d931 Convert three more WSDG chapters: works, build, and capture.
Start adding references to Qt and wsutil. Fix a file extension in
CMakeLists.txt.

Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53
Reviewed-on: https://code.wireshark.org/review/79
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:12:17 +00:00
Gerald Combs
ec6fc7690b Convert the libraries chapter to AsciiDoc.
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>
2014-02-01 19:30:01 +00:00
Gerald Combs
bdafbad955 Convert the tools chapter to AsciiDoc.
Replace SVN text with Git, other mostly-minor edits.

Change-Id: I41b602cc9334656dc8e5f37c33fb6cd660043d17
Reviewed-on: https://code.wireshark.org/review/69
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-01 18:27:15 +00:00
Gerald Combs
257e301696 Convert the quick setup chapter to AsciiDoc and start converting its
content to Git.

svn path=/trunk/; revision=54985
2014-01-27 18:43:57 +00:00
Gerald Combs
59990b7031 Fix a section name conflict.
svn path=/trunk/; revision=54973
2014-01-27 05:10:34 +00:00
Gerald Combs
5b17df040e Restore an inadvertently deleted file.
svn path=/trunk/; revision=54972
2014-01-27 04:34:25 +00:00
Gerald Combs
5344e2f2fc Migrate the build environment introduction to AsciiDoc.
svn path=/trunk/; revision=54971
2014-01-27 04:20:44 +00:00
Gerald Combs
e61a6533e7 Convert the preface to AsciiDoc with minor edits.
svn path=/trunk/; revision=54970
2014-01-27 03:08:01 +00:00
Gerald Combs
4a32b10948 Comment out the "diff" section for now. We'll have to update it for "git
diff" at some point.

svn path=/trunk/; revision=54958
2014-01-25 03:27:22 +00:00
Gerald Combs
b326fe61c7 Uncomment anchors.
svn path=/trunk/; revision=54957
2014-01-25 02:26:12 +00:00
Gerald Combs
927914a2cf Fix xpath selector. Clean up whitespace.
svn path=/trunk/; revision=54955
2014-01-25 01:09:28 +00:00
Gerald Combs
4c5bb90167 Migrate more SVN content to Git+Gerrit.
svn path=/trunk/; revision=54954
2014-01-25 01:01:04 +00:00
Gerald Combs
0555a544f4 Migrate some of the SVN-specific content to Git.
svn path=/trunk/; revision=54953
2014-01-25 00:17:46 +00:00
Gerald Combs
8997fb0d89 Start migrating the Developer's Guide to AsciiDoc. So far only one
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
2014-01-24 18:55:27 +00:00
Bill Meier
8ab9c55618 From Ville Skyttä: Spelling Fixes
https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9591


svn path=/trunk/; revision=54387
2013-12-23 15:53:13 +00:00