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.

diff --git a/doc/userguide/devguide/codebase/contributing/code-submission-process.rst b/doc/userguide/devguide/codebase/contributing/code-submission-process.rst
index bed5fa714300e4f1c82c9629362184601ea7580f..06eb84eee79a0a5038b5633232e15d916d9e757a 100644 (file)
--- a/doc/userguide/devguide/codebase/contributing/code-submission-process.rst
+++ b/doc/userguide/devguide/codebase/contributing/code-submission-process.rst
@@ -27,6 +27,16 @@ Information that needs to be part of a commit (if applicable):
 #. Coverity Scan issues addressed.
 #. 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

diff --git a/doc/userguide/install.rst b/doc/userguide/install.rst
index 8696bf1843f8619f5122605a2cbba272ce78227c..78dececd2e612ca28951e2275a6a28472266c462 100644 (file)
--- a/doc/userguide/install.rst
+++ b/doc/userguide/install.rst
@@ -59,7 +59,7 @@ Common configure options
 
 .. option:: --enable-dpdk
 
-    Enables `DPDK <https://www.dpdk.org/>` packet capture method.
+    Enables `DPDK <https://www.dpdk.org/>`_ packet capture method.
 
 Dependencies
 ^^^^^^^^^^^^

diff --git a/doc/userguide/quickstart.rst b/doc/userguide/quickstart.rst
index b96c9fd52f274f425632e0c868d96684177b58da..899de35fd4c3302bfdf42862aa02c4f441d2dcda 100644 (file)
--- a/doc/userguide/quickstart.rst
+++ b/doc/userguide/quickstart.rst
@@ -7,10 +7,9 @@ the basics. For more details, read through the more specific chapters.
 Installation
 ------------
 
-It's assumed that you run a recent Ubuntu release as the official PPA can be
-used for the installation.
-
-Installation steps::
+It's assumed that you run a recent Ubuntu release as the official PPA can then
+be used for the installation. To install the latest stable Suricata version, follow
+the steps::
 
     sudo add-apt-repository ppa:oisf/suricata-stable
     sudo apt update
@@ -18,13 +17,14 @@ Installation steps::
 
 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
-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
 :ref:`installation`.
 
-After installing Suricata, you can check what version of Suricata you have
-running and with what options as well as the service state::
+After installing Suricata, you can check which version of Suricata you have
+running and with what options, as well as the service state::
 
     sudo suricata --build-info
     sudo systemctl status suricata