Commit Graph

41 Commits

Author SHA1 Message Date
Gerald Combs dabb19572d More AsciiDoc → Asciidoctor updates.
Switch from AsciiDoc's smart quotes markup to the quotes themselves. Use
double curly quotes in place of singles.

Switch from XML entities to their direct equivalents where we can.
Switch from hex entities to decimal entities where we can't or it's not
convenient. (Asciidoctor PDF doesn't yet handle hex entities).

Change-Id: Iaf5ec33249e1c91b3d50b5d96251763243b72836
Reviewed-on: https://code.wireshark.org/review/25606
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-05 00:14:05 +00:00
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
Michael Mann 18657caf8d Add information about pre-commit script to Developer Guide.
Bug: 9553
Change-Id: I19505c3c05585a05877e9f0db06400ebb8b33985
Reviewed-on: https://code.wireshark.org/review/24585
Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-11-25 22:07:34 +00:00
Gerald Combs 6172627534 Make osx-app.sh a configured file and remove Autotools targets.
Rename osx-app.sh to osx-app.sh.in and add the version to the plugin
path at configure time.

Instead up updating Autotools accordingly just remove the macOS
packaging targets. gf61c381b5a removed support for Autotools in
osx-app.sh and if anyone wants to build macOS packages I'd prefer that
they use the same toolchain as the buildbot.

Change-Id: Ide5205265bf8859a85b1afab68fa8f8285952bd3
Reviewed-on: https://code.wireshark.org/review/23839
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-10-06 04:33:55 +00:00
Martin Kaiser f3a23a6b46 WSDG: trivial: fix a link
Asciidoc will just create a link from a URL that appears in the text. If
we want the link to appear as an address without a description, there's
no need to add an empty description. We should, however, have a space
behind the link to separate it from the text that follows.

Change-Id: Ic01b1dbbea922d785776f1965481ed58f389e30a
Reviewed-on: https://code.wireshark.org/review/21789
Reviewed-by: Martin Kaiser <wireshark@kaiser.cx>
Petri-Dish: Martin Kaiser <wireshark@kaiser.cx>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-05-29 23:58:24 +00:00
Gerald Combs 4fdc16d8e4 Docbook: Replace "OS X" with "macOS".
Change-Id: Ic2ab4f9050c9c76349d8d872b8fc2bf9feb7827d
Reviewed-on: https://code.wireshark.org/review/20325
Petri-Dish: Anders Broman <a.broman58@gmail.com>
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-03-02 11:54:31 +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 65ab2a9701 AsciiDoc: Create an include file for attributes.
Move the replacement definitions in asciidoc.conf to
attributes.asciidoc. This makes the markup a bit cleaner and is more
compatible with AsciiDoctor. Use a standard naming scheme for URLs.

Change-Id: Ica73aaadb013be2a4e6a3963fb54e6db6e02e98f
Reviewed-on: https://code.wireshark.org/review/18655
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-11-11 17:18:25 +00:00
Gerald Combs f5dff39232 Use xz to compress the source tarball.
Compress the source tarball using xz instead of bzip2. Other open source
projects (including many of our dependencies) have been using xz for a
while so hopefully this won't be too much of a shock.

Remove the patch-bzip2 Autotools target while we're here.

Change-Id: I456d27b6cd56a43aba829bd45938f98568eb7b1d
Reviewed-on: https://code.wireshark.org/review/16735
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: João Valverde <j@v6e.pt>
2016-07-29 10:55:34 +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
Graham Bloice 46876a91c2 Developers Guide Updates
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-22 08:34:11 +00:00
Jeff Morriss 1ab019f409 Fix up documentation of RPM packages.
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-12 07:08:53 +00:00
Guy Harris 0b05086754 Apple calls it just "OS X" these days.
Change-Id: I98905988ceb394d27307d1cbe883d8fe95ac23e4
Reviewed-on: https://code.wireshark.org/review/11703
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2015-11-10 21:08:45 +00:00
Graham Bloice d64cf48ce0 Fix Developers Guide link to source snapshots
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-10 00:32:39 +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
Gerald Combs 5ae8c92aa0 Try to fix NSIS packaging dependencies.
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-06-29 17:07:06 +00:00
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 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
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 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 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 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 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
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 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 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 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