Commit Graph

24 Commits

Author SHA1 Message Date
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
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
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
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 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
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
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
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
Graham Bloice 669613f41d WSDG: Remove duplicate paragraph
Change-Id: Ia96444bc463337e0ffb050a05ce4d454dd18986d
Reviewed-on: https://code.wireshark.org/review/35103
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-16 13:33:06 +00:00
Roland Knall a8052b9f38 Qt: Coloringrules Mime is encoded as JSON
Encode coloring rules as json objects to avoid encoding issues

Change-Id: I4b5369fef3c0f9e73cbb08edf14de6535ff35026
Reviewed-on: https://code.wireshark.org/review/34947
Petri-Dish: Roland Knall <rknall@gmail.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Roland Knall <rknall@gmail.com>
2019-11-04 13:09:52 +00:00
Roland Knall 013e87a8fd Qt: Remove DisplayFilterMimeData
Make the mimetype for the display filter more generic, so that external
programs can attach to Wireshark and users can drag and drop display
filters to the program

Change-Id: Id78b4dff7883e3dab879a31aad07f577d8cc4ee3
Reviewed-on: https://code.wireshark.org/review/34936
Reviewed-by: Roland Knall <rknall@gmail.com>
Petri-Dish: Roland Knall <rknall@gmail.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-04 11:39:48 +00:00
Roland Knall accd563aaf Qt: Consolidate mimedata usage
Ensure, that all mimedata uses similar mimetypes and document
the mimetypes being used throughout wireshark

Change-Id: I7c02d0a5e12a823153640e600051abb95d58cdeb
Reviewed-on: https://code.wireshark.org/review/34923
Petri-Dish: Roland Knall <rknall@gmail.com>
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
Tested-by: Petri Dish Buildbot
Reviewed-by: Roland Knall <rknall@gmail.com>
2019-11-03 15:45:34 +00:00
Gerald Combs 160f525e2c Docbook: Update macOS packaging.
Update the macOS packaging sections to reflect current reality.

Change-Id: I6795787c0d4d3c9a85da14bdb69a31fc74e9ddf2
Reviewed-on: https://code.wireshark.org/review/34624
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-09-26 19:51:53 +00:00
Gerald Combs fb5a029e47 Docbook: Fixup our table delimiters.
Update our table delimiters to match the Asciidoctor documentation.

Change-Id: I87a6834f2889e175236aa609984a9bc4dd9d3b8e
Reviewed-on: https://code.wireshark.org/review/34544
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-09-16 17:35:49 +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
Jaap Keuter 9d8f55cb05 WSDG: refine text on cloning repository
Text smells of CVS/SVN heratige.

Change-Id: I37c3309781f49149b2603ae32087ed01363460ee
Reviewed-on: https://code.wireshark.org/review/33421
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
Petri-Dish: Graham Bloice <graham.bloice@trihedral.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Martin Kaiser <wireshark@kaiser.cx>
2019-05-30 12:41:01 +00:00
Dario Lombardo 1f75694f14 docbook: add a link to the gerrit manual explaining change-ids.
Change-Id: I775e05bac8b0f8988d503bde6091922d2fab2583
Reviewed-on: https://code.wireshark.org/review/33381
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-05-28 03:33:29 +00:00
Dario Lombardo 4cfe3fb6e0 docbook: add section from wiki.
The section "Writing a Good Commit Message" from the wiki has been
incorporated in the wsdg.

Missing parenthesis fix, while here.

Bug: 15752
Change-Id: I93f2a6956d366b3e1db0deab6d884f67748d3c54
Reviewed-on: https://code.wireshark.org/review/33254
Petri-Dish: Dario Lombardo <lomato@gmail.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-05-20 04:20:13 +00:00
Gerald Combs 9887fe3d15 WSDG: Describe our tag naming conventions.
Change-Id: Icb8ba1be843b8a109713df9260330df5b215bf0b
Reviewed-on: https://code.wireshark.org/review/32318
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-03-04 18:35:06 +00:00
Gerald Combs b658de2fa7 Rename our .asciidoc files to .adoc
As noted in "AsciiDoc Recommended Practices" at
https://asciidoctor.org/docs/asciidoc-recommended-practices/, the
AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a
file extension and that's the one preferred by the Asciidoctor project.
Update our filenames to match.

Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c
Reviewed-on: https://code.wireshark.org/review/32037
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>
2019-02-15 05:17:26 +00:00