From f11a08914118255c4540430e39e5303ae6ad901a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Marjam=C3=A4ki?= <daniel.marjamaki@gmail.com>
Date: Thu, 23 Jul 2020 16:09:24 +0200
Subject: [PATCH] help/manual: update explanations about severities

---
 gui/help/severities.html | 19 +++++++++++++------
 man/manual.md            | 10 +++++-----
 2 files changed, 18 insertions(+), 11 deletions(-)

diff --git a/gui/help/severities.html b/gui/help/severities.html
index 2176ace66..791c78c68 100644
--- a/gui/help/severities.html
+++ b/gui/help/severities.html
@@ -9,32 +9,39 @@
 <h2>error</h2>
 
 <img src="images/severities-error.png"><br>
-used when bugs are found
+<p>when code is executed there is some bad behavior (undefined behavior, leak)</p>
 
 <h2>warning</h2>
 
 <img src="images/severities-warning.png"><br>
-suggestions about defensive programming to prevent bugs
+<p>when code is executed there might be undefined behavior</p>
 
 <h2>style</h2>
 
 <img src="images/severities-style.png"><br>
-stylistic issues related to code cleanup (unused functions, redundant code, constness, and such)
+<p>point out possible mistakes, and suggest more defensive programming. Examples:
+<ul>
+  <li>unused code/variables/functions
+  <li>conditions that are always true/false
+  <li>constness
+  <li>operator precedence
+</ul>
+</p>
 
 <h2>performance</h2>
 
 <img src="images/severities-performance.png"><br>
-Suggestions for making the code faster. These suggestions are only based on common knowledge. It is not certain you'll get any measurable difference in speed by fixing these messages.
+<p>Suggestions for making the code faster. These suggestions are only based on common knowledge. It is not certain you'll get any measurable difference in speed by fixing these messages.</p>
 
 <h2>portability</h2>
 
 <img src="images/severities-portability.png"><br>
-portability warnings. 64-bit portability. code might work different on different compilers. etc.
+<p>portability warnings. Implementation defined behavior. 64-bit portability. Some undefined behavior that probably works &quot;as you want&quot;. etc.</p>
 
 <h2>information</h2>
 
 <img src="images/severities-information.png"><br>
-Configuration problems. The recommendation is to only enable these during configuration.
+<p>Configuration problems. If you get such output then your code is ok but your cppcheck configuration could be improved.</p>
 
 </body>
 </html>
diff --git a/man/manual.md b/man/manual.md
index 98a2c126d..08ac44b26 100644
--- a/man/manual.md
+++ b/man/manual.md
@@ -122,15 +122,15 @@ The possible severities for messages are:
 
 **error**
 
-used when bugs are found
+when code is executed there is some bad behavior (undefined behavior, leak)
 
 **warning**
 
-suggestions about defensive programming to prevent bugs
+when code is executed there might be undefined behavior
 
 **style**
 
-stylistic issues related to code cleanup (unused functions, redundant code, constness, and such)
+stylistic issues (unused functions, redundant code, constness, operator precedence, possible mistakes, and such)
 
 **performance**
 
@@ -138,11 +138,11 @@ Suggestions for making the code faster. These suggestions are only based on comm
 
 **portability**
 
-portability warnings. 64-bit portability. code might work different on different compilers. etc.
+portability warnings. Implementation defined behavior. 64-bit portability. Some undefined behavior that probably works "as you want". etc.
 
 **information**
 
-Configuration problems. The recommendation is to only enable these during configuration.
+Configuration problems. If you get such output then your code is ok but your cppcheck configuration could be improved.
 
 ## Possible speedup analysis of template code