Commit Graph

478 Commits

Author SHA1 Message Date
Gerald Combs bfddd25f3e GitLab CI: Add more restrictions for merged commits.
Move commonly-used rules to their own hidden jobs. Use ".if-merged" to
ensure that our production build and test jobs are run automatically in
wireshark/wireshark and can be run manually in forks.

Note the new manual behavior in the Developer's Guide.
2021-04-30 20:09:33 +00:00
Chuck Craft 293eb2f534 WSDG: add mention of pluginifdemo in Qt Information 2021-04-15 07:16:09 +00:00
Gerald Combs 3b8574b244 WSDG: We build with vcpkg's libpcap on Windows. 2021-04-01 08:27:28 +00:00
João Valverde 7fee50274f Merge the caputils/ and capchild/ directories
The distinction between the different kinds of capture utility
may not warrant a special subfolfer for each, and sometimes the
distinction is not be clear or some functions could stradle
multiple "categories" (like capture_ifinfo.[ch]).

Simplify by having only a generic 'capture' subfolder. The
separate CMake libraries are kept as a way to reuse object code
efficiently.
2021-03-29 06:08:02 +01:00
Gerald Combs eceff254b6 Docs: Recommend EditorConfig.
Note that we use EditorConfig in the WSDG and README.developer, and that
you should make sure your editor uses it. Recommend 4 space indentation
more strongly. Ping #17253.

Reorder and reword the coding style sections of each document while
we're here.
2021-02-25 09:37:49 -08:00
Martin Mathieson cd77e5aa5f Some more spelling fixes.
Also add more words to dictionary file.
2021-02-21 09:59:04 +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
Chuck Craft 996bdc37bf WSDG/WSUG: Bugzilla->Gitlab Issues; bad MATE link
Bugzilla references are now Gitlab Issues.
Link to MATE tutorial page on Wiki to get config file.
2021-02-15 06:46:11 +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 bdb6e79490 DocBook: Update the packaging and CI sections in the WSDG.
Update the packaging and CI sections, and add minor updates in other
sections.
2021-01-31 15:37:22 -08:00
Jaap Keuter d2a6ca780f WSDG: Add section on expert items 2021-01-22 07:36:28 +00:00
Yehudah Aaron ab42a5dc41 WSDG: Remove reference to Gerrit, as it's no longer used
In the Wireshark Developer's Guide's "Tool Reference" chapter
remove the reference to Gerrit, as it's no longer used.
2021-01-12 06:08:21 +00:00
Moshe Kaplan 21ee5be5fe WSDG: Update section "Adding a basic dissector"
Minor restructuring and clarified phrasing to
improve clarity.
2021-01-06 10:52:31 +00:00
Jaap Keuter 2104b79479 WSDG: update protocol stats section to match current API
As proposed by Olivier Aveline
2020-12-24 11:27:45 +00: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
Stig Bjørlykke a4e9931c98 docbook: Fix example to run tests containing dumpcap 2020-11-03 19:44:36 +00:00
Gerald Combs 89b7f83541 WSDG: Update some branch name references. 2020-10-23 06:56:28 +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
Chuck Craft 83c1d5c369 docbook: update Tango Desktop link in Dev Guide #16901 2020-10-09 02:26:14 +00:00
Gerald Combs 211e375ef0 docbook: Update wiki and code review URLs.
Remove the Token Ring and SS7/E1/T1 entries from the FAQ. They've been
infrequently asked about for a very long time.
2020-09-17 22:07:11 +00:00
Gerald Combs 34f60a1cfc Test: Normalize the line endings everywhere.
Convert CRLF to LF in subprocess output everywhere, not just on Windows.
Note that we normalize output in the Developer's Guide.
2020-09-17 10:05:52 -07: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 188b4a655f README.developer: Note that sources can use UTF-8.
We started allowing source files to be encoded as UTF-8 in April 2019 in
bd75f5af0a. Update README.developer to match.

README.developer no longer has a "Code style" section, so update the
Developer's Guide to point to the "Portability" section.
2020-09-04 10:01:23 +00:00
Gerald Combs d5bafdcf5d WSDG: Add a note about "Allow commits from members..."
Recommend checking "Allow commits from members..." when creating merge
requests.
2020-09-03 03:42:11 +00:00
Jaap Keuter e48e9a5724 WSDG: remove another git review reference 2020-08-25 20:17:06 +02:00
Gerald Combs 1fe4db4bc4 WSDG: Start updating for GitLab.
Update the "Work with the Wireshark sources" chapter for GitLab.

Change-Id: I58b2f0f5eeec85c891bd7fdbb6132eb8147baabf
2020-08-23 22:45:00 -07:00
Moshe Kaplan bc231d2b98 WSDG: Add info for building with Address Sanitizer
Change-Id: I8ea916e9c0d906df5e756666b1778552efe4aa2d
Reviewed-on: https://code.wireshark.org/review/37933
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-07-23 08:26:24 +00:00
Jaap Keuter a17b0f144a WSDG: make sure _U_ is rendered correctly
Change-Id: I85b969cbd567a83a79aeb11593e14551ee1f027f
Reviewed-on: https://code.wireshark.org/review/37674
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-07-03 06:12:59 +00:00
Gerald Combs 4f1276b5fe WSDG: Update the Code Requirements section.
Update the text in the Code Requirements section. Switch to a
description list. Add a list of allowed licenses.

Change-Id: Ic9bf88bee7122684f5e3b80185be37a7e4e7b011
Reviewed-on: https://code.wireshark.org/review/37417
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-06-21 15:26:14 +00:00
Guy Harris e1d9a226a2 Fix the type of arrays of pointers to hf_ values for bitfield routines.
The static arrays are supposed to be arrays of const pointers to int,
not arrays of non-const pointers to const int.

Fixing that means some bugs (scribbling on what's *supposed* to be a
const array) will be caught (see packet-ieee80211-radiotap.c for
examples, the first of which inspired this change and the second of
which was discovered while testing compiles with this change), and
removes the need for some annoying casts.

Also make some of those arrays static while we're at it.

Update documentation and dissector-generator tools.

Change-Id: I789da5fc60aadc15797cefecfd9a9fbe9a130ccc
Reviewed-on: https://code.wireshark.org/review/37517
Petri-Dish: Guy Harris <gharris@sonic.net>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-06-19 11:32:26 +00:00
Gerald Combs 0708fadb33 WSDG: Mention CMAKE_OSX_DEPLOYMENT_TARGET.
Add an entry for CMAKE_OSX_DEPLOYMENT_TARGET to the CMake section.

Change-Id: I6b15d0e3dfeb501b61049b09a0cb94f6a9297353
Reviewed-on: https://code.wireshark.org/review/37337
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-05-30 06:46:19 +00:00
Jaap Keuter d02ea543b7 WSDG: Fix example
Fix example header field map for proto_tree_add_bitmask() adding missing
terminator.

Bug: 16582
Change-Id: Ia4fe5e9ce8bbab74ad0e17f14609568ee03c88f5
Reviewed-on: https://code.wireshark.org/review/37329
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-05-27 21:28:56 +00:00
Gerald Combs 7d3881ddc5 WSDG: Mention winget and scoop.
Note that Windows Package Manager (winget) and Scoop exist, but don't
currently provide all of the packages we require.

Change-Id: I69f6958faec3454f37eda79e5b76d3e70d399555
Reviewed-on: https://code.wireshark.org/review/37320
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-05-27 05:09:44 +00:00
Moshe Kaplan 9e4a704115 WSDG: Edits to 'How Wireshark Works'
Change-Id: Ib685631310c91ff85fc06b460ef8d011a704516d
Reviewed-on: https://code.wireshark.org/review/36722
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-04-22 07:24:27 +00:00
Dario Lombardo 9af6ceec20 docbook: clarify the use of extcap FILESELECT/MUSTEXIST.
Change-Id: I0295419a3eb0faf99f1696d7e3ac08e4af44b8cb
Reviewed-on: https://code.wireshark.org/review/36834
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-04-18 06:00:45 +00:00
Gerald Combs e9e90f67b7 Docbook: Documentation toolchain documentation updates.
Move some of the documentation about documentation toolchain itself from
docbook/README.adoc to the documentation toolchain chapter in the WSDG.

Fix the Debugger section level.

Change-Id: I8db92d334dd479324453f7b0bd25b33ea770c532
Reviewed-on: https://code.wireshark.org/review/36843
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-04-15 04:07:23 +00:00
Gerald Combs fcd51deb99 Docbook: Fix an unterminated tag, other updates.
Remove nested example tags from the dissection chapter, including and
unbalanced one. Mark our source blocks with [source,c].

Enable syntax highlighting in the Developer's and User's guides. This
isn't supported in the DocBook backend (which we use to generate the
HTML guides), but it is in the PDF backend.

Add a comment about failing on warnings when we generate our guides.

Change-Id: Ieee29fe75364ca23769aa997f90126e31b72cc8b
Reviewed-on: https://code.wireshark.org/review/36767
Petri-Dish: Guy Harris <gharris@sonic.net>
Tested-by: Petri Dish Buildbot
Reviewed-by: Guy Harris <gharris@sonic.net>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-04-09 22:07:57 +00:00
Guy Harris d30a0a2ce7 WS_DLL_PUBLIC is required on most UN*X platforms now, as well.
On UN*X platforms, we now build the Wireshark shared libraries with
compiler and linker options that arrange that most symbols are "hidden",
and only those declared with WS_DLL_PUBLIC are exported from the
libraries, if such options are available.

Change-Id: Ie954f114046fe4af678672b12cea693ac9882ba1
Reviewed-on: https://code.wireshark.org/review/36726
Reviewed-by: Guy Harris <gharris@sonic.net>
2020-04-06 17:55:32 +00:00
Moshe Kaplan 2acbaf5849 WSDG: Edits to 'Packet dissection'
Change-Id: If4aa830561b5b49e0363c454a99206baba2fb9bc
Reviewed-on: https://code.wireshark.org/review/36723
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-04-06 15:33:58 +00:00
Gerald Combs 8bf6c7b3bf WSDG: Migrate the asn2wrs content from the wiki.
Asn2wrs generates quite a bit of our dissector code, so convert some of
our asn2wrs wiki pages to a WSDG chapter. Conversion was done using the
script below and editing as needed.

----
OUT_ADOC="docbook/wsdg_src/WSDG_chapter_asn2wrs.adoc"

cp /dev/null "$OUT_ADOC"

PAGES="
    Asn2wrs
    Asn2wrs_Handmassaging_the_ASN_file
    ASN1_sample
    Asn2wrsAuxiliary
    #.END
    #.EXPORTS
    #.FN_BODY
    #.INCLUDE
    #.MODULE_IMPORT
    #.NO_EMIT
    #.PDU
    #.PDU_NEW
    #.REGISTER
    #.REGISTER_NEW
    #.USER_DEFINED
"

for PAGE in $PAGES ; do
    PAGE=${PAGE/\#/%23}
    curl "https://wiki.wireshark.org/$PAGE" \
        | xmllint --html --format --xpath '//div[@id="content"]' - \
        | pandoc -f html -t asciidoctor \
        | sed -e 's/\[\#[^ ][^ ]* .anchor\]##*//g' -e 's/\[content\]//g' \
        | cat -s \
        >> "$OUT_ADOC"
done
----

Change-Id: Ibc02b7b463dfc37abf5c2fd0a4e66f6161d290f6
Reviewed-on: https://code.wireshark.org/review/36707
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-04-05 07:02:42 +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
Gerald Combs e0a7190e41 WSDG: Add a note about the VC++ redistributable MSMs.
Change-Id: I895d43896940f044391589138b8169e206d8248c
Reviewed-on: https://code.wireshark.org/review/36306
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-05 23:57:35 +00:00
Dario Lombardo d5794990d5 docbook: add more infos to Mac package build section.
Change-Id: Iae921f64e8342d3256d39cbe2af885885da9098f
Reviewed-on: https://code.wireshark.org/review/36268
Petri-Dish: Dario Lombardo <lomato@gmail.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-03-03 20:26:36 +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 9f30fc974d WSDG: Update the libraries chapter.
C-ares is required, so don't mark it as optional. Add Win64 download
URLs and list them first. Zlib is part of our vcpkg bundle.

Change-Id: I232f4df988aa12afde0b66fff203187136504e94
Reviewed-on: https://code.wireshark.org/review/35700
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-01-09 07:56:53 +00:00
Gerald Combs 5e8da3d2ee WSDG: More translation updates.
Update the Transifex URL and describe how its resources are organized.

Change-Id: Icc03ff57da73c0a60da0ea1e7ff19d6ecffae3a1
Reviewed-on: https://code.wireshark.org/review/35637
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-01-03 18:23:19 +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