Commit Graph

49 Commits

Author SHA1 Message Date
Gerald Combs df088de18b Docs: Make our AsciiDoc markup more compatible with AsciiDoctor.
Start using markup that is preferred by Asciidoctor but compatible with
both generators.

Add a missing "cpp" attribute and set a couple of Asciidoctor-specific
compatibility attributes.

Change-Id: Iff4c31362e4493b97a85f46db2c39b18c336536f
Reviewed-on: https://code.wireshark.org/review/25600
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-04 22:46:20 +00:00
Graham Bloice 252ea22b97 WSDG: Improve VS2015 chocolatey install
Created an AdminDeployment.xml file for use with the chocolatey
package for VS2015 Community Edition and updated the WSDG to
include it.

Bug: 14147
Change-Id: Id2a701067bf38874cf0bf534cca55dba9cfd30d4
Reviewed-on: https://code.wireshark.org/review/24464
Petri-Dish: Graham Bloice <graham.bloice@trihedral.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2017-11-17 12:56:52 +00:00
Michael Mann a24f366ceb Correct instructions for choco package for VS2015.
Bug: 14039
Change-Id: Ic19c77bb091cd8ee8f824b82463d8b4bae37f625
Reviewed-on: https://code.wireshark.org/review/23437
Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-09-09 01:45:04 +00:00
Gerald Combs 0f9935e9a1 WSDG: Fix up some markup.
Change-Id: I1484e63fd9626ed507ff0077073c944cf85e3602
Reviewed-on: https://code.wireshark.org/review/23273
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-08-28 21:03:29 +00:00
Gerald Combs af180cc7d0 Update the AsciiDoc button macro name.
Change the name of the button macro to "btn" in order to be compatible
with AsciiDoctor.

Change-Id: I673e0fe0ae7b343abeb1afba0b9b11402efdf0d6
Reviewed-on: https://code.wireshark.org/review/23187
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-08-23 21:48:57 +00:00
Gerald Combs a34445c1cf WSUG+WSDG: Add a typographic conventions section.
Create a common_src directory for common guide content. Add a
typographic convention section. Update some of the content accordingly.

Change-Id: I4f69c0f52a985c48e07fa0628b19734ec691f74e
Reviewed-on: https://code.wireshark.org/review/23131
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-08-22 10:44:50 +00:00
Graham Bloice 6020f0f93d WSDG: More VS 2015 fixes
Change-Id: I5f0d543032f62bd0c57c14a56771a63fe1bed3a3
Reviewed-on: https://code.wireshark.org/review/23122
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2017-08-18 13:04:26 +00:00
Graham Bloice b1a6f11e42 WSDG: Remove obsolete VS 2010 info from quick setup
Change-Id: I767e04538d17702346e9343e136fc0ea4c2f9ec3
Reviewed-on: https://code.wireshark.org/review/23120
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2017-08-18 12:22:06 +00:00
Graham Bloice b62eee0d7f WSDG: Update Qt installation info
Change-Id: I9da1c68949ac48e3e88227e9c4f4d4930dbd3268
Reviewed-on: https://code.wireshark.org/review/23119
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2017-08-18 12:21:47 +00:00
Stig Bjørlykke 21672e51e4 WSDG: Reference to an existing Qt version
Change-Id: Ia1c61cabf1bf3378bf993501dc1362163f33f1ed
Reviewed-on: https://code.wireshark.org/review/23116
Reviewed-by: Stig Bjørlykke <stig@bjorlykke.org>
2017-08-18 10:57:46 +00:00
Gerald Combs e13a81c62a WSDG: More VS 2015 updates.
Switch the Command Prompt instructions back to using the
platform-specific variants. Switch back to setting WIRESHARK_BASE_DIR.

Change-Id: Ie9f865e5fac1312f2eb3762e439d53ab9a038bd4
Reviewed-on: https://code.wireshark.org/review/23112
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-08-17 21:56:55 +00:00
Guy Harris fc6f7b9021 Fix capitalization.
Change-Id: I43017bae5bc74678113377d0b4aad3d712647c5d
Reviewed-on: https://code.wireshark.org/review/23099
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2017-08-17 00:56:32 +00:00
Guy Harris 7df594c92e Update URL for Visual Studio Community Edition.
The old URL fetched VS 2013 when I tried it; update to a link that
fetches VS 2015.

Change-Id: Ib33e8f09bef51a532c986e70ae6ac5d9d1f1dabe
Reviewed-on: https://code.wireshark.org/review/23094
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2017-08-16 18:10:18 +00:00
Gerald Combs cdeb6f122a WSDG: Update the Windows docs and add a CMake section.
Update the Windows section for Visual Studio 2015. Copy the content from
README.cmake to its own WSDG section and remove README.cmake.

Remove the PowerShell sections. Our required version (2.0) ships with
every supported version of Windows. Remove the sed section.

Change-Id: Id37c6e71bacc247a3ed1992adb1408ec13f6a187
Reviewed-on: https://code.wireshark.org/review/22940
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-08-04 23:01:59 +00:00
Gerald Combs 52d62a6001 WSDG: Update some of the NSIS text.
Recommend v3 instead of v2.

Change-Id: I13260611dd6b12372aba8938a87574cd9a8e1a47
Reviewed-on: https://code.wireshark.org/review/19880
Reviewed-by: Jaap Keuter <jaap.keuter@xs4all.nl>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-01-31 09:04:13 +00:00
Gerald Combs 99fff00e02 WSDG: Updates for Qt 5.6.
Refer to Qt 5.6 for Windows builds. Update the download URL.

Change-Id: Id4de0d55679a6ac1b7aac82ddd5eb80d6b54568a
Reviewed-on: https://code.wireshark.org/review/17674
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2016-09-13 04:13:40 +00:00
Gerald Combs e3daf4a66d Start recommending Python 3 on Windows.
Works fine here, including git-review.

Change-Id: I8580a6b266fba09c711be8984a9f17e02a9f789f
Reviewed-on: https://code.wireshark.org/review/17097
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-08-17 23:49:47 +00:00
Dario Lombardo a7685ddae7 docbook: add tip about recommended Qt version.
Change-Id: I25d3e914c9210ca79313f6ea8b82bc7280d5c095
Reviewed-on: https://code.wireshark.org/review/16924
Reviewed-by: Dario Lombardo <lomato@gmail.com>
2016-08-10 07:29:58 +00:00
Gerald Combs 87c8be266c Switch some AsciiDoc replacements to attributes.
Many of our AsciiDoc "macros" are simple string replacements. Start
converting them to attributes.

Update the release notes.

Change-Id: I23d9ffd311f13a34c16cde3b4898b7f7bb8ba638
Reviewed-on: https://code.wireshark.org/review/15778
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-06-08 17:40:32 +00:00
Graham Bloice 2c830bbb6b docs: Updates to Developers Guide
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>
2016-01-09 22:05:36 +00:00
Alexis La Goutte e3ed5a2b16 Docbook: Use cyg-get for download Packages
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-30 17:53:14 +00:00
Alexis La Goutte 4988c51b5c Docbook: Add Example when building for Win64...
Change-Id: I8ab0388511afb3b9dd3bd16ba569a78252b8d52a
Reviewed-on: https://code.wireshark.org/review/12070
Reviewed-by: Michael Mann <mmann78@netscape.net>
2015-12-21 13:29:16 +00:00
Graham Bloice 7a6ebd76b4 Minor Doc Update for Windows build
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-20 15:48:57 +00:00
Pascal Quantin 654d4abf71 CMake: add our own FindCygwin module
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-13 14:24:05 +00:00
Pascal Quantin 7775b48987 Developer guide: add docbook-xml45 to the list of required Cygwin packages
Change-Id: Id0a241361160b03c16a6a9152c8f1a86f87b9db1
Reviewed-on: https://code.wireshark.org/review/11784
Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2015-11-12 20:58:12 +00:00
Graham Bloice 25e3a6c021 docs: Windows CMake builds
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-11-05 21:24:14 +00:00
Guy Harris c445570c49 Give instructions for installin Chcocolatey's Win flex-bison.
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-07-01 20:14:38 +00:00
Guy Harris 98a7b1eeb8 Put quotes into xcopy command and note that it might need privileges.
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-30 19:59:34 +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 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 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 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
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 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 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
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
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 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 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
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 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