diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/wsdg_src/wsdg_sources.adoc (renamed from docbook/wsdg_src/wsdg_sources.adoc) | 34 |
1 files changed, 22 insertions, 12 deletions
diff --git a/docbook/wsdg_src/wsdg_sources.adoc b/doc/wsdg_src/wsdg_sources.adoc index 9e2a3c10..38078f37 100644 --- a/docbook/wsdg_src/wsdg_sources.adoc +++ b/doc/wsdg_src/wsdg_sources.adoc @@ -25,7 +25,7 @@ such as where to find specific functionality. This is done in https://git-scm.com/[Git] is used to keep track of the changes made to the Wireshark source code. The official repository is hosted at {wireshark-gitlab-project-url}[GitLab], and incoming changes are evaluated and reviewed there. -For more information on GitLab see https://docs.gitlab.com/ce/gitlab-basics/[their documentation]. +For more information on GitLab see https://docs.gitlab.com/ee/[their documentation]. .Why Git? @@ -38,6 +38,7 @@ GitLab makes it easy to contribute. You can make changes locally and push them to your own work area at gitlab.com, or if your change is minor you can make changes entirely within your web browser. .Historical trivia: GitLab is the *fourth* iteration of our source code repository and code review system. +// Five if you include "sending patches to Gerald." Wireshark originally used https://www.nongnu.org/cvs/[Concurrent Versions System] (CVS) and migrated to https://subversion.apache.org/[Subversion] in July 2004. We migrated from Subversion to Git and https://www.gerritcodereview.com/[Gerrit] in January 2014, and from Gerrit to GitLab in August 2020. @@ -68,6 +69,11 @@ Stable release maintenance. For example, release-3.4 is used to manage the 3.4.x Tags for major releases and release candidates consist of a “v” followed by a version number such as “v3.2.1” or “v3.2.3rc0”. Major releases additionally have a tag prefixed with “wireshark-” followed by a version number, such as “wireshark-3.2.0”. +Tags created after August 1, 2024 are signed using SSH. This includes the tags for versions 4.4.0rc1, 4.4.0, 4.2.7, and 4.0.17. If you wish to verify these tags, you must have the following entry in __~/.ssh/allowed_signers__: + + gerald@wireshark.org namespaces="git" ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIBHe1qOxwBietT54lZ3qawTc8B9unWP+T3JVR9l2rQaP + +Tags were signed using GPG prior to August 2024. [#ChSrcGitWeb] === Browsing And Searching The Source Code @@ -233,14 +239,13 @@ CMake can compile Wireshark for several different build types: |Type |Compiler Flags |Description |`RelWithDebInfo` -|`-O2 -g` -|Default, build with default optimizations and generate debug symbols. -Enables assertions and disables debug level logs +|`-O2 -g -DNDEBUG` +|Build with optimizations and generate debug symbols. +Disables assertions and disables debug level logs |`Debug` -|`-O0 -g -DWS_DEBUG -DWS_DEBUG_UTF_8` -|For development, no optimization. Enables assertions -and debug level logs +|`-g -DWS_DEBUG` +|For development, no optimization. Enables assertions and debug level logs |`Release` |`-O3 -DNDEBUG` @@ -381,7 +386,7 @@ all log output generated at or above this level is sent to the log output. Note that if the <<ChSrcBuildType,build type>> is not set to `Debug` then by default all log output for the logging levels "debug" and "noisy" will be optimized away by the compiler and cannot be emitted to the log -output, regardless of the logging setings. To enable debug logging for all build +output, regardless of the logging settings. To enable debug logging for all build types, set the CMake variable `-DENABLE_DEBUG=ON`. There is also a special "echo" logging level used exclusively for temporary debugging print outs (usually @@ -637,7 +642,7 @@ For the steps below we’ll pretend that your username is “henry.perry”. . Sign in to {wireshark-gitlab-project-url} by clicking “Sign in / Register” in the upper right corner of the web page and following the login instructions. -. https://docs.gitlab.com/ce/ssh/[Add an SSH key to your account] as described in the GitLab documentation. +. https://docs.gitlab.com/ee/user/ssh.html[Add an SSH key to your account] as described in the GitLab documentation. . Make sure you have a clone of the main repository as described in <<ChSrcGit>>. @@ -875,7 +880,6 @@ If that is not possible, it *must* use a compatible license. The following licenses are currently allowed: * BSD {spdx-license-url}BSD-1-Clause.html[1], {spdx-license-url}BSD-2-Clause.html[2], {spdx-license-url}BSD-3-Clause.html[3] clause -* {spdx-license-url}GPL-3.0-or-later.html[GPL version 3 or later] *with* the https://www.gnu.org/software/bison/manual/html_node/Conditions.html[Bison parser exception] * {spdx-license-url}ISC.html[ISC] * {spdx-license-url}LGPL-2.0-or-later.html[LGPL v2 or later], including {spdx-license-url}LGPL-2.1-or-later.html[v2.1] * {spdx-license-url}MIT.html[MIT] / {spdx-license-url}X11.html[X11] @@ -960,8 +964,8 @@ $ git cherry-pick -x 1ab2c3d4 $ ninja $ ... -# OPTIONAL: Add entries to docbook/release-notes.adoc. -$EDITOR docbook/release-notes.adoc +# OPTIONAL: Add entries to doc/release-notes.adoc. +$EDITOR doc/release-notes.adoc # If you made any changes, update your commit. git commit --amend -a @@ -1086,6 +1090,12 @@ instead of https://1.na.dl.wireshark.org/download/src/wireshark-{wireshark-version}.tar.xz [discrete] +===== Staying Current + +Wireshark releases are announced on the link:{wireshark-mailing-lists-url}[wireshark-announce] mailing list. +A https://appvisor.com/pad/[PAD] file is also published at https://www.wireshark.org/wireshark-pad.xml which contains the current stable version and release date. + +[discrete] ===== Artwork Logo and icon artwork can be found in the _image_ directory in the |