Skip to content

Commit

Permalink
doc: Document new stage-1-to-2 failure reporting
Browse files Browse the repository at this point in the history
  • Loading branch information
samueldr committed Dec 3, 2019
1 parent 83a1735 commit f7b1af3
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/in-depth/index.adoc
Expand Up @@ -7,6 +7,10 @@ include::_support/common.inc[]

Index of in-depth topics.

== Boot

* <<stage-1.adoc#,Stage-1>>

== Android-Based Devices

* <<android/partitions.adoc#,Partitions>>
26 changes: 26 additions & 0 deletions doc/in-depth/stage-1.adoc
@@ -0,0 +1,26 @@
= Notes about `stage-1`
include::_support/common.inc[]

== What is stage-1?

This is what is also referred as `initrd`, or `initramfs`. `stage-1` refers to
the fact that this is the first part of the system that gets run once the kernel
has been started.

== About "sad phone" screens

It may happen that you have a "sad phone" screen when booting.

This means that a fatal error has happened.

When there is no screen logging available for the device, the general case of
error has been codified as a background color.

* Yellow (`0xFFFF00`) means that mounting the root filesystem was not possible.
* Fuchsia (`0xFF00FF`) means that mounting succeeded, but no compatible generation was found to boot.
* Red (`0xFF0000`) means that executing (`exec`) and switching to the found generation's init failed.

It may happen that the boot seemingly or actually hangs before a "sad phone"
screen appears. In those instances, it means something else earlier kept the
early init scripts to continue. In the future, better logging and status
reporting will be added to keep track of early failures.

0 comments on commit f7b1af3

Please sign in to comment.