forked from osmocom/wireshark
Docs: Remove some Buildbot references.
This commit is contained in:
Gerald Combs
Wireshark GitLab Utility
parent
b086e5192a
commit
3cae0847fb
|
|
@ -16,7 +16,7 @@
|
|||
|
||||
// Wireshark top level URLs (sites)
|
||||
:wireshark-main-url: https://www.wireshark.org/
|
||||
:wireshark-bugs-url: https://gitlab.com/wireshark/wireshark/issues
|
||||
:wireshark-bugs-url: https://gitlab.com/wireshark/wireshark/-/issues
|
||||
:wireshark-code-review-url: https://gitlab.com/wireshark/wireshark/-/merge_requests
|
||||
:wireshark-qa-url: https://ask.wireshark.org/
|
||||
:wireshark-wiki-url: https://gitlab.com/wireshark/wireshark/wikis/
|
||||
|
|
@ -24,9 +24,9 @@
|
|||
|
||||
// Wireshark secondary URLs (pages)
|
||||
:wireshark-authors-url: {wireshark-main-url}about.html#authors
|
||||
:wireshark-buildbot-url: https://buildbot.wireshark.org/wireshark-master/waterfall
|
||||
:wireshark-code-browse-url: https://gitlab.com/wireshark/wireshark/tree/master
|
||||
:wireshark-code-file-url: https://gitlab.com/wireshark/wireshark/blob/master/
|
||||
:wireshark-commits-url: https://gitlab.com/wireshark/wireshark/-/commits/master
|
||||
:wireshark-merge-request-url: https://gitlab.com/wireshark/wireshark/merge_requests
|
||||
:wireshark-developers-guide-url: {wireshark-main-url}docs/wsdg_html_chunked/
|
||||
:wireshark-display-filter-reference-url: {wireshark-main-url}docs/dfref/
|
||||
|
|
|
|||
|
|
@ -229,15 +229,17 @@ Later chapters describe the required tools and libraries in detail.
|
|||
|
||||
[[ChIntroAutomated]]
|
||||
|
||||
=== Automated Builds (GitLab CI And Buildbot)
|
||||
=== Automated Builds (GitLab CI)
|
||||
|
||||
The Wireshark development team uses GitLab’s continuous integration (CI) system and Buildbot to automatically build Wireshark for each Git merge request and commit. Automated builds provide several useful services:
|
||||
The Wireshark development team uses GitLab’s continuous integration (CI) system to automatically build Wireshark for each Git merge request and commit.
|
||||
Automated builds provide several useful services:
|
||||
|
||||
* Cross-platform testing.
|
||||
Inbound merge requests and commits can be tested on each of our supported plaforms, which ensures that a developer on one platform doesn’t break the build on other platforms.
|
||||
|
||||
* A health indicator for the source code.
|
||||
The CI badges at https://gitlab.com/wireshark/wireshark/ and the waterfall status at https://buildbot.wireshark.org/wireshark-master/ can quickly tell you how healthy the latest code is. Green is good, red is bad.
|
||||
The CI badges at {wireshark-gitlab-project-url} can quickly tell you how healthy the latest code is.
|
||||
Green is good, red is bad.
|
||||
|
||||
* Fast code delivery.
|
||||
After a change is committed to the repository, an installer is usually available within an hour at https://www.wireshark.org/download/automated/.
|
||||
|
|
@ -248,7 +250,8 @@ The Wireshark development team uses GitLab’s continuous integration (CI) syste
|
|||
|
||||
==== What Do The Automated Builds Do?
|
||||
|
||||
GitLab’s CI and Buildbot operate by running a series of steps and reporting success or failure. A typical CI job might do the following:
|
||||
GitLab’s CI operates by running a series of steps and reporting success or failure.
|
||||
A typical CI job might do the following:
|
||||
|
||||
. Check out Wireshark from the source repository.
|
||||
|
||||
|
|
@ -259,8 +262,7 @@ GitLab’s CI and Buildbot operate by running a series of steps and reporting su
|
|||
. Run regression tests.
|
||||
|
||||
GitLab’s CI marks successful jobs with a green checkmark and failed jobs with a red “X”.
|
||||
Buildbot similarly colors successful jobs and steps green and failed ones red.
|
||||
Jobs and steps provide a link to the corresponding console logfile which provides additional information.
|
||||
Jobs provide a link to the corresponding console logfile which provides additional information.
|
||||
|
||||
Release packages are built on the following platforms:
|
||||
|
||||
|
|
@ -413,12 +415,10 @@ someone answers your question.
|
|||
|
||||
[[ChIntroBugDatabase]]
|
||||
|
||||
==== Bug database (Gitlab Issues)
|
||||
==== Bug Database (Gitlab Issues)
|
||||
|
||||
The Wireshark community collects bug reports in an issues database at
|
||||
{wireshark-bugs-url}. This database is filled with manually filed bug
|
||||
reports, usually after some discussion on wireshark-dev, and automatic
|
||||
bug reports from the Buildbot tools.
|
||||
The Wireshark community collects bug reports in an issues database at {wireshark-bugs-url}.
|
||||
This database is filled with manually filed bug reports, usually after some discussion on wireshark-dev, and automatic bug reports from continuous integration jobs.
|
||||
|
||||
[[ChIntroReportProblems]]
|
||||
|
||||
|
|
|
|||
|
|
@ -154,12 +154,12 @@ The `--shallow-since=1year` option limits cloned commits to the last 1 year.
|
|||
The `--depth=5000` option limits cloned commits to the last 5000.
|
||||
--
|
||||
|
||||
[[ChSrcBuildbot]]
|
||||
[[ChSrcDevelopmentSnapshots]]
|
||||
==== Development Snapshots
|
||||
|
||||
This method is useful for one-off builds or if Git is inaccessible (e.g. because of a restrictive firewall).
|
||||
|
||||
The Buildbot server automatically generates development packages, including source packages.
|
||||
Our GitLab CI configuration automatically generates development packages, including source packages.
|
||||
They can be found at {wireshark-snapshots-url}.
|
||||
Packages are available for recent commits in the master branch and each release branch.
|
||||
|
||||
|
|
@ -179,12 +179,10 @@ you might want to keep them in sync with the sources at the upstream
|
|||
Git repository.
|
||||
|
||||
[TIP]
|
||||
.Take a look at the Buildbot first
|
||||
.Take a look at the recent commits first
|
||||
====
|
||||
As development evolves, the Wireshark sources are compilable
|
||||
most of the time -- but not always. You should take a look at
|
||||
{wireshark-buildbot-url} before fetching or pulling to make
|
||||
sure the builds are in good shape.
|
||||
As development evolves, the Wireshark sources are compilable most of the time -- but not always.
|
||||
You should take a look at {wireshark-commits-url} before fetching or pulling to make sure the builds are in good shape.
|
||||
====
|
||||
|
||||
[[ChSrcAnonUpdate]]
|
||||
|
|
|
|||
|
|
@ -77,14 +77,9 @@ As of May 2020 neither option provides all of the packages we require, but that
|
|||
|
||||
=== CMake
|
||||
|
||||
Wireshark’s build environment can be configured using CMake on various
|
||||
UNIX-like platforms, including Linux, macOS, and *BSD, and on Windows.
|
||||
CMake is designed to support out-of-tree builds - so much so that
|
||||
in-tree builds do not work properly in all cases. Along with being
|
||||
cross-platform, CMake supports many build tools and environments
|
||||
including traditional make, Ninja, and MSBuild. Our Buildbot runs
|
||||
CMake steps on Ubuntu, Win32, Win64, and macOS. In particular, the
|
||||
macOS and Windows packages are built using CMake.
|
||||
Wireshark’s build environment can be configured using CMake on various UNIX-like platforms, including Linux, macOS, and *BSD, and on Windows.
|
||||
CMake is designed to support out-of-tree builds - so much so that in-tree builds do not work properly in all cases.
|
||||
Along with being cross-platform, CMake supports many build tools and environments including traditional make, Ninja, and MSBuild.
|
||||
|
||||
Building with CMake typically includes creating a build directory and
|
||||
specifying a *generator*, aka a build tool. For example, to build
|
||||
|
|
|
|||
Loading…
Reference in New Issue