Commit Graph

253 Commits

Author SHA1 Message Date
Peter Wu fa04dfdd77 wsdg: clarify gerrit account requirement
A IRC user was asking about the meaning of `my.username` and noted that
information is scattered over places. This patch tries to make the
documentation more friendly for newcomers which are unfamiliar with
Gerrit (and maybe OpenID?).

The login page already recommends Launchpad, so no need to write it
here.

Change-Id: Ic55c9a2073d0045c6367f3efc8c842e53215f2dd
Reviewed-on: https://code.wireshark.org/review/8288
Reviewed-by: Mark <launchpad@markcunningham.ie>
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-05-05 23:47:19 +00:00
Gerald Combs 1404605513 Start moving win-setup to PowerShell.
Add win-setup.ps1, which duplicates the following tasks performed by
config.nmake + Makefile.nmake + win-setup.sh:

- Create the windows library directory.
- Download files.
- Download and unpack zip files.
- Check and set current-tag.txt

Don't verify applications or libraries. CMakeLists.txt does that.

Update the Developer's Guide.

Have POWERSHELL_COMMAND use dot sourcing instead of "-File", which
appears to be a synonym for "-IgnoreTheExitStatusReturnedByThisScript".

This removes our dependencies on unzip and wget and reduces our dependency
on bash.

Change-Id: Ia9def24acbe183d81b9d477fa42e655e4a3a6614
Reviewed-on: https://code.wireshark.org/review/7990
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: Gerald Combs <gerald@wireshark.org>
2015-04-14 19:09:30 +00:00
Gerald Combs fd72024bc2 Move the PortabaleApps packaging up one level.
Update the PA section of the Developer's Guide.

Change-Id: I383d2a2405e742eb353390f5a43fd6d6d32cb25b
Reviewed-on: https://code.wireshark.org/review/8012
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-04-10 17:16:21 +00:00
Gerald Combs 9147961908 Add a warning about Chocolatey's Wget package.
Its CA certificate configuration appears to be incomplete. Recommend
Cygwin's instead.

Change-Id: I0e7ddbfbb2a37f2872a820442e2d185f20ef551e
Reviewed-on: https://code.wireshark.org/review/7948
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-04-06 19:28:49 +00:00
Gerald Combs 7787c1b464 Fixup our anonsvn URLs.
Change-Id: Id18d392bf7ff948fc78b684d8222c5c3725d302a
Reviewed-on: https://code.wireshark.org/review/7886
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-04-02 19:21:41 +00:00
Balint Reczey 7e87dddf6f Update command used for generating .debs in WSDG
Change-Id: I50e224087a3bdd92d166c6767ea5ef959d1d5aa2
Reviewed-on: https://code.wireshark.org/review/7878
Reviewed-by: Balint Reczey <balint@balintreczey.hu>
Tested-by: Balint Reczey <balint@balintreczey.hu>
2015-04-01 15:33:19 +00:00
Gerald Combs e991610467 Update the buildbot URL.
Change-Id: Ia3a9e8e919d3702a4499351df0289294cd10f808
Reviewed-on: https://code.wireshark.org/review/7634
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-03-10 23:51:52 +00:00
Gerald Combs cac102eee3 Change a lot of http:// URLs to https://.
Most of our sites are now HTTPS-only. Update URLs accordingly. Update
other URLs while we're at it. Remove or comment out dead links.

Change-Id: I7c4f323e6585d22760bb90bf28fc0faa6b893a33
Reviewed-on: https://code.wireshark.org/review/7621
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-03-10 19:30:50 +00:00
Peter Wu 4ca3dbae94 tcp: support variable-length tcp_dissect_pdus
Originally suggested by Bill Meier for the MQTT protocol[1], but the
Websocket protocol can also benefit from this. Since
DESEGMENT_ONE_MORE_SEGMENT is a valid packet length, use the zero length
instead as an indicator that the length is not yet known.

Updated documentation too and remove the function documentation from
packet-tcp.c since it is duplicated in packet-tcp.h.

A noteworthy WSDG change is that the get_pdu_len parameter of
tcp_dissect_pdus gained another void pointer since
v1.99.2rc0-890-gceb8d95 ("Lua: Expose tcp_dissect_pdus() to Lua").

 [1]: https://www.wireshark.org/lists/wireshark-dev/201405/msg00044.html

Change-Id: I4eba380e00cd757635eb5639c2857356dae3171e
Reviewed-on: https://code.wireshark.org/review/7279
Reviewed-by: Guy Harris <guy@alum.mit.edu>
Reviewed-by: Michael Mann <mmann78@netscape.net>
Petri-Dish: Michael Mann <mmann78@netscape.net>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Evan Huus <eapache@gmail.com>
2015-03-06 04:02:00 +00:00
Gerald Combs da62086687 WSUG: Add more dialog guidelines.
Change-Id: I59a14bf9712c05d75398b8ed2dc103fe3443f7af
Reviewed-on: https://code.wireshark.org/review/7203
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-17 20:35:26 +00:00
Gerald Combs f85d1c801d WSUG: Add a note about dialogs vs windows.
Change-Id: I38d7838db2be59af8a31d94b7cafeeef62698215
Reviewed-on: https://code.wireshark.org/review/7105
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-13 19:19:11 +00:00
Gerald Combs d2aa2c610d WSDG: Start adding Qt material.
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>
2015-02-12 20:38:34 +00:00
Gerald Combs 61e3bdc7ce WSDG: Wrap a line.
Change-Id: I21e573c3800a245cbdae4fcb4d4cfaf36f3a0abd
Reviewed-on: https://code.wireshark.org/review/6976
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-06 00:59:46 +00:00
Gerald Combs d1380119d4 WSDG: Fixup admonition block formatting.
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>
2015-02-05 17:50:45 +00:00
Richard Sharpe dff82e6034 Update the Windows build documentation with some common traps that stop people
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>
2015-02-05 16:16:52 +00:00
Gerald Combs 342ba909f9 Minor WSDG updates.
Change-Id: I847af9ef7f18b271a5a2dc8da6c5817735a8c856
Reviewed-on: https://code.wireshark.org/review/6941
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-04 01:14:29 +00:00
Gerald Combs 71fd34da6c WSUG: Chocolatey updates.
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>
2015-02-02 22:47:28 +00:00
Graham Bloice e102c34cf0 Minor doc changes for Windows build
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>
2015-02-02 16:30:46 +00:00
Graham Bloice 70912c8925 Minor doc update for Wwindows build
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>
2015-02-01 11:10:22 +00:00
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