Sometimes what looks like a kernel bug is actually some local problem
the kernel's log messages explain, thus it is best if users check it
early in the process.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
---
.../admin-guide/reporting-issues.rst | 29 +++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
index 73b7792d84cdf1..63ce6ae51df266 100644
--- a/Documentation/admin-guide/reporting-issues.rst
+++ b/Documentation/admin-guide/reporting-issues.rst
@@ -77,6 +77,14 @@ following the others is usually in your own interest.
[:ref:`details <multiple_repiref>`]
+.. _checklog_repisbs:
+
+* Skim ``journalctl -k`` (alternatively: ``dmesg``) for failures and warnings,
+ as maybe there is just something wrong with your setup.
+
+ [:ref:`details <checklog_repiref>`]
+
+
* Perform a rough search for existing reports with your favorite internet
search engine; additionally, check the archives of the `Linux Kernel Mailing
List (LKML) <https://lore.kernel.org/lkml/>`_. If you find matching reports,
@@ -368,6 +376,27 @@ entangled or clearly have the same cause.
[:ref:`back to step-by-step guide <multiple_repisbs>`]
+.. _checklog_repiref:
+
+Evaluate the logs
+-----------------
+
+ *Skim 'journalctl -k' (alternatively: 'dmesg') for failures and warnings, as
+ maybe there is just something wrong with your setup.* [:ref:`... <checklog_repisbs>`]
+
+Sometimes a bug you face is just a symptom of something going sideways that the
+kernel detected and logged -- like a missing firmware file, for example. To rule
+such things out, check the kernel's log messages.
+
+Preferably use 'journalctl' if your distribution supports it, as in contrast to
+'dmesg' it always contains all messages since the kernel started.
+
+Especially look out for messages in bold, yellow, or red, as both tools use such
+to set warnings and errors apart.
+
+[:ref:`back to step-by-step guide <checklog_repisbs>`]
+
+
Search for existing reports, first run
--------------------------------------
--
2.51.0