[PATCH v2] docs: admin-guide: Clarify sentences

From: Cristian Souza <cristianmsbr@gmail.com>
To: linux-kernel@vger.kernel.org
Cc: linux-doc@vger.kernel.org, corbet@lwn.net
Subject: [PATCH v2] docs: admin-guide: Clarify sentences
Date: Wed, 8 Apr 2020 11:46:53 -0300	[thread overview]
Message-ID: <20200408144653.GA123268@darkstar> (raw)

Changes to make the text more formal and organized. The reasons are now cited and described at the same time.
Minor grammatical problems have also been fixed.

Signed-off-by: Cristian Souza <cristianmsbr@gmail.com>
---
 Documentation/admin-guide/init.rst | 35 ++++++++++++++----------------
 1 file changed, 16 insertions(+), 19 deletions(-)

diff --git a/Documentation/admin-guide/init.rst b/Documentation/admin-guide/init.rst
index 68f2f6cf456b..0c2c9138f268 100644
--- a/Documentation/admin-guide/init.rst
+++ b/Documentation/admin-guide/init.rst
@@ -1,34 +1,30 @@
-Explaining the dreaded "No working init found." boot hang message
-=================================================================
+Explaining the "No working init found." boot hang message
+=========================================================

-OK, so you have got this pretty unintuitive message (currently located
-in init/main.c) and are wondering what went wrong.
-Some high-level reasons for failure (listed roughly in order of execution)
-to load the init binary are:
+Message location: ``init/main.c``

-A) Unable to mount root FS
-B) init binary doesn't exist on rootfs
-C) Broken console device
-D) Binary exists but dependencies not available
-E) Binary cannot be loaded
+This document provides some high-level reasons for failure
+(listed roughly in order of execution) to load the init binary.

-Detailed explanations:
-
-A) Set "debug" kernel parameter (in bootloader config file or CONFIG_CMDLINE)
+1) **Unable to mount root FS**: Set "debug" kernel parameter (in bootloader config file or CONFIG_CMDLINE)
    to get more detailed kernel messages.
-B) Make sure you have the correct root FS type
+
+2) **init binary doesn't exist on rootfs**: Make sure you have the correct root FS type
    (and ``root=`` kernel parameter points to the correct partition),
    required drivers such as storage hardware (such as SCSI or USB!)
    and filesystem (ext3, jffs2, etc.) are builtin (alternatively as modules,
-   to be pre-loaded by an initrd)
-C) Possibly a conflict in ``console= setup`` --> initial console unavailable.
+   to be pre-loaded by an initrd).
+
+3) **Broken console device**: Possibly a conflict in ``console= setup`` --> initial console unavailable.
    E.g. some serial consoles are unreliable due to serial IRQ issues (e.g.
    missing interrupt-based configuration).
    Try using a different ``console= device`` or e.g. ``netconsole=``.
-D) E.g. required library dependencies of the init binary such as
+
+4) **Binary exists but dependencies not available**: E.g. required library dependencies of the init binary such as
    ``/lib/ld-linux.so.2`` missing or broken. Use
    ``readelf -d <INIT>|grep NEEDED`` to find out which libraries are required.
-E) Make sure the binary's architecture matches your hardware.
+
+5) **Binary cannot be loaded**: Make sure the binary's architecture matches your hardware.
    E.g. i386 vs. x86_64 mismatch, or trying to load x86 on ARM hardware.
    In case you tried loading a non-binary file here (shell script?),
    you should make sure that the script specifies an interpreter in its shebang
@@ -50,3 +46,4 @@ Further TODOs:
   e.g. by providing additional error messages at affected places.

 Andreas Mohr <andi at lisas period de>
+Cristian Souza <cristianmsbr at gmail period com>
--
2.25.1
