docs: admin-guide: Clarify sentences
PATCH v2 1/1 docs: admin-guide: Clarify sentences
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.
--- Documentation/admin-guide/init.rst | 35 ++++++++++++++---------------- 1 file changed, 16 insertions(+), 19 deletions(-)
Documentation/admin-guide/init.rst +16 -19
@@ -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
Documentation/admin-guide/init.rst line 4
Quoted 11 lines · Cristian Souza
Documentation/admin-guide/init.rst +3
-6@@ -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``
I don't think this should be the first paragraph ;-)
Maybe just skip it altogether? The sysadmin doesn't care where the message is located.
Documentation/admin-guide/init.rst line 27
Quoted 1 line
Documentation/admin-guide/init.rst +1
-0+5) **Binary cannot be loaded**: Make sure the binary's architecture matches your hardware.
Line exceeds 80 characters (other occurrences of this)
Documentation/admin-guide/init.rst Further TODOs: · line 49
Quoted 4 lines
Documentation/admin-guide/init.rst +1
-0e.g. by providing additional error messages at affected places. Andreas Mohr <andi at lisas period de> +Cristian Souza <cristianmsbr at gmail period com>
We tend to use :Author: at the top of the file instead of signatories at the bottom.
Removal of unnecessary sentences, identification of authors at the top of the file, and correction of the number of characters per line.
--- Documentation/admin-guide/init.rst | 57 +++++++++++++++--------------- 1 file changed, 28 insertions(+), 29 deletions(-)
Documentation/admin-guide/init.rst +28 -29
@@ -1,38 +1,39 @@ Explaining the "No working init found." boot hang message ========================================================= - -Message location: ``init/main.c`` +:Authors: Andreas Mohr <andi at lisas period de> + Cristian Souza <cristianmsbr at gmail period com> This document provides some high-level reasons for failure (listed roughly in order of execution) to load the init binary. -1) **Unable to mount root FS**: Set "debug" kernel parameter (in bootloader config file or CONFIG_CMDLINE) - to get more detailed kernel messages. +1) **Unable to mount root FS**: Set "debug" kernel parameter (in bootloader + config file or CONFIG_CMDLINE) to get more detailed kernel messages. -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). +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). -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). +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=``. -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. - -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 - header line (``#!/...``) that is fully working (including its library - dependencies). And before tackling scripts, better first test a simple - non-script binary such as ``/bin/sh`` and confirm its successful execution. - To find out more, add code ``to init/main.c`` to display kernel_execve()s - return values. +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. + +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 header line (``#!/...``) that is fully working (including its + library dependencies). And before tackling scripts, better first test a + simple non-script binary such as ``/bin/sh`` and confirm its successful + execution. To find out more, add code ``to init/main.c`` to display + kernel_execve()s return values. Please extend this explanation whenever you find new failure causes (after all loading the init binary is a CRITICAL and hard transition step
@@ -42,8 +43,6 @@ Further TODOs: - Implement the various ``run_init_process()`` invocations via a struct array which can then store the ``kernel_execve()`` result value and on failure log it all by iterating over **all** results (very important usability fix). -- Try to make the implementation itself more helpful in general, - e.g. by providing additional error messages at affected places. +- Try to make the implementation itself more helpful in general, 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
Jonathan Corbet
maintainerQuoted 7 lines · On Thu, 9 Apr 2020 16:46:37 -0300 Cristian Souza <[email protected]> wrote:
Removal of unnecessary sentences, identification of authors at the top of the file, and correction of the number of characters per line.
Signed-off-by Cristian Souza <[email protected]>--- Documentation/admin-guide/init.rst | 57 +++++++++++++++--------------- 1 file changed, 28 insertions(+), 29 deletions(-)
So this says "v2", but it's a reply to another "v2", so it's really a new version, right?
In situations like this, please:
- Change the version number!
- Add a comment under the "---" line saying what changed
- Post the patch standalone, rather than a reply in an existing thread.
Thanks,
jon