aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/wsdg_src
AgeCommit message (Collapse)AuthorFilesLines
2016-02-24Extend reassembly documentationPeter Wu1-18/+27
Documentation changes only (comments and docbook). Update WSDG with the fragment_add_seq_check API that was introduced in Wireshark 1.10. Fix typos and clarify the many functions we have for adding reassembling fragments. Change-Id: I38715a8f58e9cf1fe3e34ee4b1a4ae339630282b Reviewed-on: https://code.wireshark.org/review/14066 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2016-01-09docs: Updates to Developers GuideGraham Bloice2-7/+12
Update link to Gerrit. Update Windows Git section with info on install options and updated links. Fix CMake section header level. Change-Id: I24769534e07e79a0608201e103cb8f1b8625cf86 Reviewed-on: https://code.wireshark.org/review/13158 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2015-12-30Docbook: Use cyg-get for download PackagesAlexis La Goutte2-4/+10
Chocolatey don't support --source cygwin on 0.9.9.x ... https://github.com/chocolatey/choco/wiki/CommandsInstall#alternative-sources Change-Id: Ifa3f0fa0a6cbb88537c727bf64e06dce9916dbb2 Reviewed-on: https://code.wireshark.org/review/12069 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-12-30improved the developer documentationBarbu Paul - Gheorghe1-7/+5
* tvb_*_length mentioned in README.dissector * fixed typos in README.dissector * using stats_tree_register_plugin in the stats_tree examples both in README.stats_tree and the dev guide * removed the version information and the #endif from the stats tree section in README.dissector Change-Id: I27df0b5dfd66a7c0ac5b0fe1bdc882b3e9ffda74 Reviewed-on: https://code.wireshark.org/review/12908 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Michael Mann <mmann78@netscape.net>
2015-12-21Docbook: Add Example when building for Win64...Alexis La Goutte1-1/+5
Change-Id: I8ab0388511afb3b9dd3bd16ba569a78252b8d52a Reviewed-on: https://code.wireshark.org/review/12070 Reviewed-by: Michael Mann <mmann78@netscape.net>
2015-11-29Docbook: We no longer support Windows Server 2003.Gerald Combs1-21/+13
Try to clarify 2003 and XP support in the User's and Developer's guides. Change-Id: Id08b21374485bf7655b83bb20b7c3d70f8871499 Reviewed-on: https://code.wireshark.org/review/12275 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-11-24Developers Guide updates for plugins with CMakeGraham Bloice1-8/+12
Remove references to nmake, add references to CMake. Change-Id: Iea2d2b2fbdbab131bae823d5d6a5306630a70347 Reviewed-on: https://code.wireshark.org/review/12079 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-11-22Developers Guide UpdatesGraham Bloice7-118/+72
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>
2015-11-20Minor Doc Update for Windows buildGraham Bloice1-1/+3
Update the docs to indicate the modified -G parameter required for CMake when building an x64 version. Change-Id: I9cc75ca99daf248111242c2962df313de32ca0d1 Reviewed-on: https://code.wireshark.org/review/11992 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-11-13CMake: add our own FindCygwin modulePascal Quantin1-0/+7
The one from official CMake (3.3.2) does not look for the default 64bits installation path. Let's add it. Also add a WIRESHARK_CYGWIN_INSTALL_PATH environment variable allowing to force it. For reference, registry based detection fails to detect a 64bits installation because it gets redirected to the Wow6432 node. Change-Id: If3172494e3ab232e094389b493e6b67023662ae5 Reviewed-on: https://code.wireshark.org/review/11769 Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com> Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2015-11-12Developer guide: add docbook-xml45 to the list of required Cygwin packagesPascal Quantin1-1/+3
Change-Id: Id0a241361160b03c16a6a9152c8f1a86f87b9db1 Reviewed-on: https://code.wireshark.org/review/11784 Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2015-11-12Fix up documentation of RPM packages.Jeff Morriss2-8/+18
Specify which ./configure options are passed into the RPM. Describe the 3 package RPM package names and their contents. Describe how to enable parallel builds when making RPMs. RPM now stands for "RPM Package Manager." Fix some markup problems. Change-Id: I1664aa0956719e872d302a4af2c092318f5eea6d Reviewed-on: https://code.wireshark.org/review/11737 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-11-10Apple calls it just "OS X" these days.Guy Harris3-12/+11
Change-Id: I98905988ceb394d27307d1cbe883d8fe95ac23e4 Reviewed-on: https://code.wireshark.org/review/11703 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2015-11-10Fix Developers Guide link to source snapshotsGraham Bloice1-1/+1
Change-Id: I16280d3fd4023c5a16026e8e10f1d12dfca45641 Reviewed-on: https://code.wireshark.org/review/11657 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>
2015-11-05docs: Windows CMake buildsGraham Bloice6-349/+150
Updated the WSDG Windows build instructions to use CMake. Change-Id: I5006c07e09ec6f628e8bc44006a3f1086e831a3c Reviewed-on: https://code.wireshark.org/review/11485 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>
2015-07-01Give instructions for installin Chcocolatey's Win flex-bison.Guy Harris1-1/+8
Fix a typo ("and and") while we're at it. Change-Id: Ib68bbdf0b358f56b36cf53906f105c5ee6493ec4 Reviewed-on: https://code.wireshark.org/review/9446 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2015-06-30Put quotes into xcopy command and note that it might need privileges.Guy Harris1-2/+4
The pathnames have spaces, so they must be quoted. At least on my VM, I had to run it as Administrator. Change-Id: I7600edbdbe3205c7f766cc651bd6b86340efa0ff Reviewed-on: https://code.wireshark.org/review/9429 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2015-06-29Try to fix NSIS packaging dependencies.Gerald Combs1-5/+22
Split the nsis_package target into nsis_package_prep which has dependencies and nsis_package which has no dependencies and as a result blindly builds the package. Remove the nsis_uninstaller target since that's now handled by nsis_package_prep. Nsis_package_prep *should* also take care of the dependencies for portableapps_package, but that hasn't been tested. Update the Developer's Guide. This requires coordination with the Windows buildbots. Change-Id: Ib9e3141832c782355135a1637fba5a07c2ca4ba1 Reviewed-on: https://code.wireshark.org/review/9217 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-05-05wsdg: clarify gerrit account requirementPeter Wu1-8/+17
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-04-14Start moving win-setup to PowerShell.Gerald Combs2-10/+10
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-10Move the PortabaleApps packaging up one level.Gerald Combs1-5/+9
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-06Add a warning about Chocolatey's Wget package.Gerald Combs1-4/+6
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-02Fixup our anonsvn URLs.Gerald Combs1-3/+2
Change-Id: Id18d392bf7ff948fc78b684d8222c5c3725d302a Reviewed-on: https://code.wireshark.org/review/7886 Reviewed-by: Gerald Combs <gerald@wireshark.org>
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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-25 03:47:17 +0000