Commit Graph

53 Commits

Author SHA1 Message Date
Roland Knall 645b9ab7f4 Qt6: Adapt various docs 2022-08-23 10:37:14 +00:00
João Valverde b33210750c CMake+etc: Enable Qt6 by default for Unix builds
Linux builds were left behind on the Qt transition, presumably because
our Ubuntu CI image does not support Qt6.

Enable Qt6 by default and explicitly disable it for slower or more
conservative Linux distros.

Drop experimental status for Qt6, because we are using it to build
official Windows and macOS releases.
2022-08-22 09:08:06 +00:00
Gerald Combs 49dda8c71e Make Perl optional.
Update our documentation, build configuration, and setup scripts to make
Perl optional.
Closes #18152.
2022-07-23 21:12:25 +00:00
Gerald Combs 75efbb1ac4 Rename Logwolf to Logray
Switch to the name "Logray" for the log analyzer. Rays are biological
cousins of sharks and more people like the name "Logray" in a completely
unscientific survey here. Apologies for any inconvenience this might
cause.
2022-07-06 15:04:25 +00:00
Chuck Craft ff4663931c wsdg: docbook\README.adoc - filename 2022-06-22 16:27:21 +00:00
Gerald Combs de1a4c3774 CMake: Update package target names.
Rename the rpm-package target to wireshark_rpm and the appimage target
to wireshark_appimage.
2022-06-08 17:56:21 +00:00
Gerald Combs 056fd8a1e3 NSIS: Update some target and filenames.
Rename the following build targets, similar to the recent macOS target
name changes:

nsis_package_prep to wireshark_nsis_prep
nsis_package to wireshark_nsis

Rename some NSIS files to reflect that they're specific to Wireshark.
Update the documentation and CI configurations.
2022-06-02 16:33:31 -07:00
Gerald Combs a930a78686 Docs: We no longer require Bison / YACC.
f21cd2e23f Removed our last Bison / YACC file. Update the Developer's
Guide to match.
2022-06-02 13:24:48 -07:00
Gerald Combs 370c58f913 macOS: Add Logwolf packaging targets.
Rename the following build targets:

app_bundle to wireshark_app_bundle
dmg_package_prep to wireshark_dmg_prep
dmg_package to wireshark_dmg

Add logwolf_app_bundle, logwolf_dmg_prep, and logwolf_dmg targets and
packaging assets. Update the documentation.

We need to add a set of Logwolf version variables to CMake and
make-version.pl. Add a static logwolf-version attribute to
attributes.adoc in the mean time.
2022-05-26 20:29:20 +00:00
Gerald Combs c3d9f11b8b Docs: Remove "win32" references from the guides.
Ping #17779.
2022-04-24 23:39:58 +00:00
Gerald Combs 829fb032e4 CMake: Add support for WIRESHARK_QT6_PREFIX_PATH.
If USE_qt6 is enabled, set CMAKE_PREFIX_PATH to WIRESHARK_QT6_PREFIX_PATH
if it's defined. This lets you more easily switch between Qt 5 and
6 builds. Note that we have experimental support for Qt 6 in the
Developer's Guide.
2022-03-22 22:01:33 +00:00
Gerald Combs 3abd163127 Docs: Start migrating the Developer's Guide to Visual Studio 2022. 2022-02-03 03:05:03 +00:00
Gerald Combs fad709a582 Docs: Use modern Asciidoctor section IDs.
Change our legacy block anchors to section IDs as described at

https://docs.asciidoctor.org/asciidoc/latest/sections/custom-ids/
2022-01-17 18:56:26 +00:00
Gerald Combs 019f8aa26e Docbook: Fix some section ID / anchor markup.
Finish renaming ChSetupWin32 to ChSetupWindows. Make ChSetupWin32 a
proper secondary ID as described at

https://docs.asciidoctor.org/asciidoc/latest/sections/custom-ids/

Remove some obsolete IDs.
2022-01-16 18:19:53 +00:00
Gerald Combs bf7f6c19d5 WSDG: Update some winget notes.
Start tracking winget package support in comments in the Windows quick
setup section.
2022-01-09 10:17:26 +00:00
Gerald Combs 2de477f499 Docs: Prefer 64-bit Windows.
Document the 64-bit Windows build options first and switch to
"Wireshark-win64" in a couple of places.
2021-12-18 17:45:03 +00:00
Gerald Combs 07c4059277 GitLab CI+Qt+Docs: CMAKE_PREFIX_PATH updates.
Qt's documentation recommends using CMAKE_PREFIX_PATH to designate your
Qt installation prefix: https://doc.qt.io/qt-5/cmake-get-started.html.
Do so in GitLab's CI and update the Developer's Guide.
2021-12-16 18:47:18 -08:00
Gerald Combs aac98e48d8 Docbook: Python installation updates.
Try to describe as briefly and clearly as possible where Python might
end up being installed. Fixes #17712.
2021-12-06 05:54:07 +00:00
Gerald Combs c939df8f61 Docbook: Windows toolchain updates.
Visual Studio and Qt tend to install their own copies of CMake.

We build the 3.6 branch with Visual C++ 2019.
2021-12-06 05:09:58 +00:00
Darius Davis 9bf24deb2d WSDG: Trivial cleanups.
Fix a bogus URL in a comment in the asn2wrs documentation.

Switch a backslash in the Unix Quick Setup instructions to a slash.

Insert commas in two places where they are needed.
2021-10-04 17:49:11 +00:00
Gerald Combs 84ab55cf75 Docs+Packaging: Convert our man pages to Asciidoctor.
Convert doc/*.pod to Asciidoctor. This:

* Means we use the same markup for our man pages, the guides, and
  release notes.
* Lets us add versions to our man pages.
* Gives us more formatting options, e.g. AsciiDoc supports `commands`,
  nested lists and makes it easy to include version information. The
  manpage backend doesn't seem to support tables very well,
  unfortunately.

Convert our CMake configuration to produce *roff and html man pages
using Asciidoctor. Add a "manarg" block macro which makes our synopses
wrap correctly.

Similar to the release notes, guides, and FAQ, if Asciidoctor isn't
found the man pages won't be generated or installed.

Move Asciidoctor to the list of package build dependencies in various
places.

This commit includes the conversion script (pod2adoc.py), which will be
removed later.

Line count sanity check:

Man page         .pod .adoc
androiddump       260  280
asn2deb            93  105
capinfos          401  471
captype            54   55
ciscodump         241  269
dftest             42   42
dpauxmon          153  169
dumpcap           464  534
editcap           528  583
etwdump           136  156
extcap            157  181
idl2deb            91  103
idl2wrs           120  100
mergecap          206  207
mmdbresolve        75   75
randpkt           107  111
randpktdump       158  184
rawshark          558  610
reordercap         76   78
sdjournal         145  157
sshdump           272  302
text2pcap         274  312
tshark           2135 2360
udpdump           133  151
wireshark-filter  486  479
wireshark        2967 3420
2021-10-01 16:42:34 +00:00
Gerald Combs 0b567bb27e Docs: Asciidoctor.js isn't yet suitable for our needs.
Reverse the text added in cdd6f2ec80 and note that we can't yet use
Asciidoctor.js to build our documentation. I'm not sure how I managed to
miss this in my initial tests, but Asciidoctor.js is missing Docbook,
PDF, and EPUB backends, and doesn't support Ruby macros.
2021-09-23 06:40:08 +00:00
Berk Akinci 9d65d3f889 DOC: Remove redundancy in build instructions.
Consolidate build instructions and troubleshooting into WSDG chapter 2.
Remove (moved) troubleshooting note that libpcap is required.

Link from WSUG build instructions to the WSDG chapters.

Reorder WSUG to have install instructions before build instructions for both
Windows and Unix.

Link from WSDG build instructions in WSDG sources chapter back to
WSDG chapter 2.

Offer options to the 'git clone' lines in obtaining sources: '--depth' and
'--shallow-since'

Add brief descriptions of new options mentioned.
2021-09-10 04:38:56 +00:00
Gerald Combs cdd6f2ec80 CMake+docs: Use Asciidoctor.js if it's available.
Add the executables shipped by the Asciidoctor.js project to
FindAsciidoctor.cmake, and update the Developer's Guide to match.
2021-06-23 05:28:55 +00:00
Gerald Combs 853c438b8e WSUG: Add a note about installing a JRE.
Note that Chocolatey doesn't support altnerative package dependencies,
and that you have to install a JRE separately when installing
AscidoctorJ as a result.
2021-06-22 10:47:17 -07:00
Chuck Craft fd99368364 WSDG: Update Qt and MSVC versions 2021-05-05 21:46:50 +00:00
Guy Harris 812c9f5b81 rpm-setup, WSDG: add a --install-rpm-deps option to install rpm-build.
This matches what deb-setup does - it has an --install-deb-deps optionto
install tools necessary to build a .deb.

Document it in the WSDG while we're at it.
2021-02-15 09:48:51 +00:00
Guy Harris 28dbff322b WSDG: add UN*X targets for building packages. 2021-02-12 22:25:31 -08:00
Guy Harris b67494e32a WSDG: give more details on setting up a UNIX build environment.
List the minimum set of tools required.

We have scripts to do the setup work on a number of platforms.  Let the
user know about them.

Give instructions on using CMake; we're not using the traditional
autoconf stuff any more.

Give instructions on building the Developer's and User's Guides in the
UNIX section, and, in both that section *and* the equivalent Windows
section, give the name of the build target for building all guides.
2021-02-12 15:00:07 -08:00
Gerald Combs f21cd2e23f wiretap: Convert ascend.y to Lemon.
Convert wiretap/ascend.y.in from Bison/YACC to Lemon and rename it to
wiretap/ascend_parser.lemon. Tighten up some of our scanning and
parsing. Make the indentation in it and related files consistent. Aside
from the recent IPv4 fragment offset changes, this produces identical
output to the 3.4 branch for the Ascend trace files I have here.

Remove the comment about supporting other commands. Another timeline
might have an Ascend that successfully pivoted to DSL or 15625B+1D
gigabit ISDN, but this one has neither.

This was our last/only Bison/YACC file, so remove Bison/YACC as a
development and packaging dependency and remove references to it from
the documentation.
2020-11-30 08:15:43 +00:00
Dario Lombardo 1fbc6315c0 docs: remove references to gerrit. 2020-10-16 12:51:13 +00:00
Роман Донченко 88b0370f86 Fix spelling errors in the documentation 2020-10-12 11:43:47 +00:00
Martin Mathieson 43a85d674e Fix more spelling errors in the docbook folder.
There are some lines that show as changed in 'git gui', will see how
they look in gitlab..
2020-09-06 12:11:09 +00:00
Gerald Combs e3f6dd4af3 WSDG: Expand the VS command prompt text.
Add links to the command prompt documentation and mention that you can
set up a VC++ environment in an existing command prompt.

Change-Id: I74a2e1450ad1113ef94896fc2c6dbd06d96e3d40
Reviewed-on: https://code.wireshark.org/review/36352
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2020-03-09 22:09:11 +00:00
Dario Lombardo be90029975 docbook: remove legacy "trap".
vcredist is now shipped with VS. No need to download it, then no
chance of getting the wrong one.

Change-Id: I90f3874d6e09dfb4de736756ef39274c028a5441
Reviewed-on: https://code.wireshark.org/review/36311
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-03-06 18:05:30 +00:00
Jaap Keuter 9ea4bd2b96 doc: Apply proper capitalization to the Wireshark name
Change-Id: I9d29cd705c9af39bae6cffdefaba0b9c8b4bb2e6
Reviewed-on: https://code.wireshark.org/review/36081
Petri-Dish: Anders Broman <a.broman58@gmail.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-02-17 04:40:16 +00:00
Gerald Combs 4778386e71 WSDG: Miscellaneous updates.
Add a note about case sensitive directories on Windows.

Recommend the "winflexbison3" Chocolatey package.

Update our list of Linux distributions.

Change-Id: I4676453941a66de71215d6ce6cf7057623c92fec
Reviewed-on: https://code.wireshark.org/review/35622
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-01-03 16:36:11 +00:00
Dario Lombardo bb70d49dfd docbook: make all examples use 64bit architecture.
The WSDG is a mix of references to 32 and 64 architectures. Use 64
in more places.

Change-Id: Ifb4b3189912268808cfe8fdb5119f2177c815163
Reviewed-on: https://code.wireshark.org/review/35248
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-28 22:55:24 +00:00
Dario Lombardo 5f23791f82 docbook: put a space after PS prompts.
Change-Id: I7e55471b19a3dd526d1de1269062853a72e75dec
Reviewed-on: https://code.wireshark.org/review/35226
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-27 01:35:58 +00:00
Dario Lombardo 25bbe6654a docbook: add warning about using an old version of Windows.
Change-Id: I537fbb26681555d0cd303d4b614bc016e935eb70
Reviewed-on: https://code.wireshark.org/review/35225
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
Petri-Dish: Graham Bloice <graham.bloice@trihedral.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-27 01:35:54 +00:00
Dario Lombardo 12204f1a4b docbook: minor fixes.
Change-Id: I2de1f3df60847b011e7b93d12a0b73e581c4a9d7
Reviewed-on: https://code.wireshark.org/review/35222
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-27 01:35:51 +00:00
Graham Bloice b22a63d025 docs: fix up MS toolchain references
Updated the toolchain references to VS 2019,
removing mentions of 2015 & 2017.

Bug: 16211
Change-Id: Ic1607ac2c2713a5d324d40319c4e1be5365eb6f7
Reviewed-on: https://code.wireshark.org/review/35180
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
Petri-Dish: Guy Harris <guy@alum.mit.edu>
Tested-by: Petri Dish Buildbot
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-11-21 20:14:48 +00:00
Gerald Combs 655f7442ae WSDG: Add an "or".
Change-Id: I3f068dcdf4b7df1e54a742ccf55983aae200eba5
Reviewed-on: https://code.wireshark.org/review/34550
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-09-16 22:47:54 +00:00
Gerald Combs c8ce89111d WSDG: Visual Studio fixes.
Convert a single numbered list to a simple paragraph. Generalize a
reference to to the VS Community Edition in one place and fix the VS
version in another.

Start using one sentence per line as recommended at
https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line

Change-Id: Iaa2a830d6cdb034c8057e4a6c45935e65d1d387e
Reviewed-on: https://code.wireshark.org/review/34519
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-09-16 17:37:11 +00:00
Gerald Combs 3bff8f372e WSDG: Updates for Visual Studio 2019.
Start recommending Visual Studio 2019.

Change-Id: I743844691baf6798f708aca48dd73da8d7fb6aeb
Reviewed-on: https://code.wireshark.org/review/34508
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-09-12 03:47:55 +00:00
Peter Wu c88e525168 Documentation: convert http URLS to https
Remove some dead links or point them to archive.org while at it. All
updated links have been verified.

Change-Id: Icf02167a13d5fe9dfce39ea57525b3f185554c9d
Reviewed-on: https://code.wireshark.org/review/34028
Petri-Dish: Peter Wu <peter@lekensteyn.nl>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-07-20 20:51:30 +00:00
Graham Bloice 93303118d4 Developers Guide: Fix issue with Windows env vars
Change-Id: I2f78cf59267196c2994f7f16934562074afa9f4f
Reviewed-on: https://code.wireshark.org/review/33358
Petri-Dish: Graham Bloice <graham.bloice@trihedral.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2019-05-25 18:25:22 +00:00
Graham Bloice 0636c267d9 developers-guide: restore winflexbison to Windows install
Change-Id: I46d0822b2939793990b7e0ef6a34bd421335c919
Reviewed-on: https://code.wireshark.org/review/33337
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
Petri-Dish: Graham Bloice <graham.bloice@trihedral.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Guy Harris <guy@alum.mit.edu>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-05-24 03:43:32 +00:00
Gerald Combs 3b8bf168e6 WSDG: Let Windows developers know that they need Perl.
Add an "Install Perl" section to the "Win32/64: Step-by-Step Guide"
section. Recommend Strawberry Perl first there and in the "Microsoft
compiler toolchain" chapter under the theory that if it's good enough
for Larry Wall then it's good enough for us.

Bug: 15512
Change-Id: I9a01c7ae2da01b98fd20b64d29144577a8f456b2
Reviewed-on: https://code.wireshark.org/review/32088
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-19 08:44:33 +00:00
Guy Harris 751ab080eb Remove whitespace from the end of the line.
Change-Id: I9dc504e8f5ab97021876f12376ac2c6f20258288
Reviewed-on: https://code.wireshark.org/review/32052
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-02-16 00:41:44 +00:00