* [PATCH v2] docs: admin-guide: Clarify sentences @ 2020-04-08 14:46 Cristian Souza 2020-04-09 18:13 ` Matthew Wilcox 0 siblings, 1 reply; 4+ messages in thread From: Cristian Souza @ 2020-04-08 14:46 UTC (permalink / raw) To: linux-kernel; +Cc: linux-doc, corbet 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 ^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v2] docs: admin-guide: Clarify sentences 2020-04-08 14:46 [PATCH v2] docs: admin-guide: Clarify sentences Cristian Souza @ 2020-04-09 18:13 ` Matthew Wilcox 2020-04-09 19:46 ` Cristian Souza 0 siblings, 1 reply; 4+ messages in thread From: Matthew Wilcox @ 2020-04-09 18:13 UTC (permalink / raw) To: Cristian Souza; +Cc: linux-kernel, linux-doc, corbet On Wed, Apr 08, 2020 at 11:46:53AM -0300, Cristian Souza wrote: > @@ -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. > +5) **Binary cannot be loaded**: Make sure the binary's architecture matches your hardware. Line exceeds 80 characters (other occurrences of this) > e.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. ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v2] docs: admin-guide: Clarify sentences 2020-04-09 18:13 ` Matthew Wilcox @ 2020-04-09 19:46 ` Cristian Souza 2020-04-10 16:18 ` Jonathan Corbet 0 siblings, 1 reply; 4+ messages in thread From: Cristian Souza @ 2020-04-09 19:46 UTC (permalink / raw) To: Matthew Wilcox, linux-kernel, linux-doc, corbet 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 <cristianmsbr@gmail.com> --- Documentation/admin-guide/init.rst | 57 +++++++++++++++--------------- 1 file changed, 28 insertions(+), 29 deletions(-) diff --git a/Documentation/admin-guide/init.rst b/Documentation/admin-guide/init.rst index 0c2c9138f268..41f06a09152e 100644 --- a/Documentation/admin-guide/init.rst +++ b/Documentation/admin-guide/init.rst @@ -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 ^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v2] docs: admin-guide: Clarify sentences 2020-04-09 19:46 ` Cristian Souza @ 2020-04-10 16:18 ` Jonathan Corbet 0 siblings, 0 replies; 4+ messages in thread From: Jonathan Corbet @ 2020-04-10 16:18 UTC (permalink / raw) To: Cristian Souza; +Cc: Matthew Wilcox, linux-kernel, linux-doc On Thu, 9 Apr 2020 16:46:37 -0300 Cristian Souza <cristianmsbr@gmail.com> 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 <cristianmsbr@gmail.com> > --- > 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 ^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-04-10 16:18 UTC | newest] Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2020-04-08 14:46 [PATCH v2] docs: admin-guide: Clarify sentences Cristian Souza 2020-04-09 18:13 ` Matthew Wilcox 2020-04-09 19:46 ` Cristian Souza 2020-04-10 16:18 ` Jonathan Corbet
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).