This commit adds four keyboard shortcuts to the developer
documentation that were found from reading the source:
Esc: Toggle between system console and plymouth boot animation.
Ctrl-V: Toogle verbose mode on and off.
Ctrl-U or Ctrl-W: erase a line
This commit starts to document plymouth to help
new contributors get into the code.
The aim of the document is to provide useful information,
such as the overall architecture, the most
important data structures, and howto recipes for
typical user cases, like debugging.
The document is explicitly not meant to be detailed API documentation.
In the future, that type of documentation may be provided with gtk-doc
style annotations.
The documentation is written in asciidoc
(http://www.methods.co.nz/asciidoc/) and is therefore easily readable as
its ascii text and can also be translated into more rich formats
(like HTML).
For example, to get an HTML version of the document:
yum install asciidoc (or equivalent for your distribution)
cd docs
make development.html
They weren't completely accurate, you don't need to reinstall
grub after editing its config, since it has built-in filesystem
drivers. Also, those details very from system to system, so we
should probably just leave it out.
We don't want to provide a history of what distributions
used before plymouth, because that history could get long,
isn't super relevant, and will add noise for a users looking
for help (they probably only care about their distributions,
not others).
