Skip to content
This repository was archived by the owner on May 6, 2024. It is now read-only.

Commit

Permalink
Merge pull request #56 from kvch/add-more-dev-tools
Browse files Browse the repository at this point in the history
tools: add Criterion && Astyle description
  • Loading branch information
lbudai authored Nov 7, 2016
2 parents bfa816c + 70bb0ef commit 7018fb3
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions chapters/chapter_4/section_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,49 @@ like to do this CI will be run on your pull-request.

[Travis CI balabit/syslog-ng](http://travis-ci.org/balabit/syslog-ng)

## Criterion

Criterion is a unit test framework used in the unit tests of syslog-ng. It can be compiled from
source or installed as it is available as a .deb package.

Its documentation is extensive and full of examples. More test examples can be found in the source of
syslog-ng under the `tests/unit` folder.

### Installation on Ubuntu

```
$ curl http://download.opensuse.org/repositories/home:/laszlo_budai:/syslog-ng/xUbuntu_12.04/Release.key | sudo apt-key add -
$ echo "deb http://download.opensuse.org/repositories/home:/laszlo_budai:/syslog-ng/xUbuntu_12.04 ./" | sudo tee --append /etc/apt/sources.list.d/syslog-ng-obs.list
$ sudo apt install criterion criterion-dev
```

[Documentation of Criterion](https://criterion.readthedocs.io/en/master/)

## Astyle

Astyle is a source code formatter which makes sure that all of the C sources are formatted properly.
Please make sure that version `2.05.1` is installed, as there might be differences between the formatting
of different versions.

The version `2.05.1` can be also installed from the OBS repository used above.

### Usage

It is advised to format sources before submitting a PR. This makes easier to process PRs both for the reviewers and the contributors. To check if there is a adly formatted file run `make style-check`. To correct
badly formatted ones run `make style-format`.

Following is the sampla output of calling these commands.

```
$ make style-check
Checking C source files
Formatting tests/unit/test_example.c
Number of badly formatted files: 1
$ make style-format
Formatting C source files
Formatting tests/unit/test_example.c
```

## Coverity

Coverity is an online service that helps you to analyze your code statically (Coverity Scan). It can reveal many defects
Expand Down

0 comments on commit 7018fb3

Please sign in to comment.