docs: miscellanea updates

- Fix a DPDK reference link, add some line breaks.
- Exemplify what a good commit message looks
like, for Suricata's commit style.
pull/9336/head
Juliana Fajardini 2 years ago committed by Victor Julien
parent ae5c65fb49
commit 765b05f139

@ -27,6 +27,16 @@ Information that needs to be part of a commit (if applicable):
#. Coverity Scan issues addressed. #. Coverity Scan issues addressed.
#. Static analyzer error it fixes (cppcheck/scan-build/etc) #. Static analyzer error it fixes (cppcheck/scan-build/etc)
When in doubt, check our git history for other messages or changes done to the
same module your're working on. This is a good example of a `commit message
<https://github.com/OISF/suricata/commit/33fca4d4db112b75ffa22eb2e6f14f038cbcc1f9>`_::
pcap/file: normalize file timestamps
Normalize the timestamps that are too far in the past to epoch.
Bug: #6240.
.. _pull-requests-criteria: .. _pull-requests-criteria:
Pull Requests Pull Requests

@ -59,7 +59,7 @@ Common configure options
.. option:: --enable-dpdk .. option:: --enable-dpdk
Enables `DPDK <https://www.dpdk.org/>` packet capture method. Enables `DPDK <https://www.dpdk.org/>`_ packet capture method.
Dependencies Dependencies
^^^^^^^^^^^^ ^^^^^^^^^^^^

@ -7,10 +7,9 @@ the basics. For more details, read through the more specific chapters.
Installation Installation
------------ ------------
It's assumed that you run a recent Ubuntu release as the official PPA can be It's assumed that you run a recent Ubuntu release as the official PPA can then
used for the installation. be used for the installation. To install the latest stable Suricata version, follow
the steps::
Installation steps::
sudo add-apt-repository ppa:oisf/suricata-stable sudo add-apt-repository ppa:oisf/suricata-stable
sudo apt update sudo apt update
@ -18,13 +17,14 @@ Installation steps::
The dedicated PPA repository is added, and after updating the index, Suricata can The dedicated PPA repository is added, and after updating the index, Suricata can
be installed. We recommend installing the ``jq`` tool at this time as it will help be installed. We recommend installing the ``jq`` tool at this time as it will help
with displaying information from Suricata's EVE JSON output (described later in this guide). with displaying information from Suricata's EVE JSON output (described later in
this guide).
For the installation on other systems or to use specific compile options see For the installation on other systems or to use specific compile options see
:ref:`installation`. :ref:`installation`.
After installing Suricata, you can check what version of Suricata you have After installing Suricata, you can check which version of Suricata you have
running and with what options as well as the service state:: running and with what options, as well as the service state::
sudo suricata --build-info sudo suricata --build-info
sudo systemctl status suricata sudo systemctl status suricata

Loading…
Cancel
Save