summaryrefslogtreecommitdiff
path: root/docbook/wsdg_src
AgeCommit message (Collapse)AuthorFilesLines
2015-04-01Update command used for generating .debs in WSDGBalint Reczey1-1/+1
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-03-10Update the buildbot URL.Gerald Combs1-1/+1
Change-Id: Ia3a9e8e919d3702a4499351df0289294cd10f808 Reviewed-on: https://code.wireshark.org/review/7634 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-03-10Change a lot of http:// URLs to https://.Gerald Combs1-13/+13
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-06tcp: support variable-length tcp_dissect_pdusPeter Wu1-10/+17
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-02-17WSUG: Add more dialog guidelines.Gerald Combs1-0/+21
Change-Id: I59a14bf9712c05d75398b8ed2dc103fe3443f7af Reviewed-on: https://code.wireshark.org/review/7203 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-13WSUG: Add a note about dialogs vs windows.Gerald Combs1-0/+11
Change-Id: I38d7838db2be59af8a31d94b7cafeeef62698215 Reviewed-on: https://code.wireshark.org/review/7105 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-12WSDG: Start adding Qt material.Gerald Combs1-5/+101
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-06WSDG: Wrap a line.Gerald Combs1-1/+2
Change-Id: I21e573c3800a245cbdae4fcb4d4cfaf36f3a0abd Reviewed-on: https://code.wireshark.org/review/6976 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-05WSDG: Fixup admonition block formatting.Gerald Combs1-15/+9
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-05Update the Windows build documentation with some common traps that stop peopleRichard Sharpe1-2/+20
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-04Minor WSDG updates.Gerald Combs1-19/+6
Change-Id: I847af9ef7f18b271a5a2dc8da6c5817735a8c856 Reviewed-on: https://code.wireshark.org/review/6941 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-02WSUG: Chocolatey updates.Gerald Combs4-51/+121
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-02Minor doc changes for Windows buildGraham Bloice1-18/+4
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-01Minor doc update for Wwindows buildGraham Bloice1-1/+9
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-01-14Minor Development Guide updatesGraham Bloice2-13/+14
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-09Some more random removal of ep_ memory.Michael Mann1-1/+1
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-02Try to clarify the PowerShell requirements.Gerald Combs2-6/+14
Change-Id: Ie4ad0388b920ba4a8483ad8af351ddbdd121a28b Reviewed-on: https://code.wireshark.org/review/6254 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-29Minor doc updates, added Windows debugging infoGraham Bloice2-34/+66
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-28Move Windows build to be VS2013 based using the Community EditionGraham Bloice5-583/+279
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-11-09WSUG: Convert ``Command Line Tools'' to AsciiDoc.Gerald Combs2-1/+189
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-10-03WSDG: Update the Windows Qt download text.Gerald Combs1-15/+6
Change-Id: I6fd027ff76b5b463f33992898965a3e037778071 Reviewed-on: https://code.wireshark.org/review/4443 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-19Update the documentation to use "Wireshark.pro".Gerald Combs1-15/+9
Change-Id: I024a882030e489cbd273a4245b0cd3be656f060f Reviewed-on: https://code.wireshark.org/review/4191 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-17Update the docbook directory to use https://www.wireshark.org.Gerald Combs1-3/+3
Change-Id: Ied91158cb055b0235b4a5106c3eb6b9300997c32 Reviewed-on: https://code.wireshark.org/review/4141 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-13README.dissector was split from README.developer in 2013 - update someJoerg Mayer3-15/+16
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-02Fix PortableApps packaging.Gerald Combs2-3/+59
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-08-14Windows: Clean up text file packaging.Gerald Combs2-90/+67
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-11Minor typo correctionsEugene Sukhodolin3-6/+6
Change-Id: I5962ba6a9b9285095ddacf00307a3094c697461a Reviewed-on: https://code.wireshark.org/review/3546 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-08-07Update the Developer's Guide for Chocolatey's Win flex-bison.Gerald Combs2-49/+66
Change-Id: Id86a00b521e112e445856251f0c242fbb7a2573b Reviewed-on: https://code.wireshark.org/review/3482 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-07-21Start converting the User's Guide to AsciiDoc.Gerald Combs2-2/+2
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-12Remove some $Id$ linesJoerg Mayer2-8/+0
Change-Id: Idec3769750f5a433b184e6e9fb44cbad23a29c60 Reviewed-on: https://code.wireshark.org/review/3023 Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-07-02Update WSDG win32/win64 quick start guide to include dependencies andTim Furlong1-6/+56
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-06-24dos2unix is now in Utils, not Base.Guy Harris1-2/+2
Change-Id: Ib430582270a2b788843785fd5aa7148ebe0f8871 Reviewed-on: https://code.wireshark.org/review/2597 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-23Point the user at http://www.cygwin.com/install.html for downloads.Guy Harris1-3/+4
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-22Point to the Cygwin mirrors page.Guy Harris1-6/+12
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-2264-bit Cygwin's dependencies for Bison are wrong; it doesn't require m4.Guy Harris1-0/+7
Change-Id: Id6a6c0a7c09ed1d9eb1e1d522930e3f94e7b20d6 Reviewed-on: https://code.wireshark.org/review/2554 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22Remove trailing white space, copyedit, add a missing period.Guy Harris1-5/+5
Change-Id: I300d723a6f93293ebdf97c5ef6ac3e9b72c692ee Reviewed-on: https://code.wireshark.org/review/2533 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22Update to reflect current reality.Guy Harris2-19/+27
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-05-01Fixed typo in docbook (usuall to usually)Sean O. Stalley1-1/+1
Change-Id: I1aad1d6487cb6acd52bb851c08d9c4965bbb9f55 Reviewed-on: https://code.wireshark.org/review/1449 Reviewed-by: Evan Huus <eapache@gmail.com>
2014-04-30SVN --> GIT in a few places. Fixes Bug #10060.Bill Meier1-7/+7
Change-Id: I5dcf7699e295dcdbd1e870af5ec68b010a63bf6f Reviewed-on: https://code.wireshark.org/review/1434 Reviewed-by: Bill Meier <wmeier@newsguy.com>
2014-04-10Comment out a section re SVN usage; svn ==> git in a few cases; Fix some typos.Bill Meier1-53/+54
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-02Add a backporting chapter.Gerald Combs1-28/+49
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-03-16Small updates to the setup process documentationJoerg Mayer2-8/+22
Change-Id: Ie6dc3a8254e30495945155f058f1ef10a75c4745 Reviewed-on: https://code.wireshark.org/review/700 Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-02-25Fix indentation and numbering.Gerald Combs1-2/+4
Change-Id: Ic1b528db9128420e106affcc8b3639d2d5fc65c0 Reviewed-on: https://code.wireshark.org/review/397 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-25Add back an anchor removed in gc55c57a.Gerald Combs1-0/+2
Change-Id: I9795278b759d1a965abd9b22dc023c70fce19b77 Reviewed-on: https://code.wireshark.org/review/391 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-25Add Git+Gerrit command line instructions.Gerald Combs2-167/+146
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-25Clean up some more subversion references in the documentation.Jeff Morriss1-1/+1
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-11Finish converting the Developer's Guide to AsciiDoc.Gerald Combs2-29/+1
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-06Convert the user interface chapter to AsciiDoc.Gerald Combs2-254/+210
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-03Convert the dissection chapter to AsciiDoc.Gerald Combs2-1209/+1138
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-02Convert three more WSDG chapters: works, build, and capture.Gerald Combs6-319/+243
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>