]> rtime.felk.cvut.cz Git - novaboot.git/commitdiff
Doc: Add a concise list of execution phases
authorMichal Sojka <sojkam1@fel.cvut.cz>
Tue, 16 Dec 2014 12:13:56 +0000 (13:13 +0100)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Tue, 16 Dec 2014 12:13:56 +0000 (13:13 +0100)
README.md
novaboot

index 8551f502c2b7a3c0fd712fdaea490addadc556a9..ab85c50d2cb155d7a2e4a6fb630c4fe3b5372b7e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -71,8 +71,20 @@ from it.
 
 Novaboot performs its work in several phases. Each phase can be
 influenced by several command line options, certain phases can be
-skipped. The list of phases (in the execution order) and the
-corresponding options follows.
+skipped. The list of phases (in the execution order) is as follows.
+
+- 1. [Configuration reading](#configuration-reading-phase)
+- 2. [Command line processing](#command-line-processing-phase)
+- 3. [Script preprocessing](#script-preprocessing-phase)
+- 4. [File generation](#file-generation-phase)
+- 5. [Target connection](#target-connection-check)
+- 6. [File deployment](#file-deployment-phase)
+- 7. [Target power-on and reset](#target-power-on-and-reset-phase)
+- 8. [Interaction with the bootloader](#interaction-with-the-bootloader-on-the-target)
+- 9. [Target interaction](#target-interaction-phase)
+
+Each phase is described in the following sections together with the
+command line options that control it.
 
 ## Configuration reading phase
 
index c76eaa5111d72ed55a85b211bc143f4b0ae2c4d7..085a7f35c6aba9decddb8e761a87501d6b28d721 100755 (executable)
--- a/novaboot
+++ b/novaboot
@@ -1262,8 +1262,32 @@ I<script2> configurations.
 
 Novaboot performs its work in several phases. Each phase can be
 influenced by several command line options, certain phases can be
-skipped. The list of phases (in the execution order) and the
-corresponding options follows.
+skipped. The list of phases (in the execution order) is as follows.
+
+=over
+
+=item 1. L<Configuration reading|/Configuration reading phase>
+
+=item 2. L<Command line processing|/Command line processing phase>
+
+=item 3. L<Script preprocessing|/Script preprocessing phase>
+
+=item 4. L<File generation|/File generation phase>
+
+=item 5. L<Target connection|/Target connection check>
+
+=item 6. L<File deployment|/File deployment phase>
+
+=item 7. L<Target power-on and reset|/Target power-on and reset phase>
+
+=item 8. L<Interaction with the bootloader|/Interaction with the bootloader on the target>
+
+=item 9. L<Target interaction|/Target interaction phase>
+
+=back
+
+Each phase is described in the following sections together with the
+command line options that control it.
 
 =head2 Configuration reading phase