Give more structure to syntax documentation

diff --git a/README.pod b/README.pod
index 6b6a68c5ec8b38c39a94b9a8cf6e371feaf9fa11..f32f33f19d764b2b1430da22ad81af6cb489e3ee 100644 (file)
--- a/README.pod
+++ b/README.pod
@@ -688,7 +688,14 @@ Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
 expression) assign values to internal variables. See L</VARIABLES>
 section.
 
-Lines starting with C<load> keyword represent modules to boot. The
+Otherwise, the first word on the line defines the meaning of the line.
+The following keywords are supported:
+
+=over 4
+
+=item C<load>
+
+These lines represent modules to boot. The
 word after C<load> is a file name (relative to the build directory
 (see B<--build-dir>) of the module to load and the remaining words are
 passed to it as the command line parameters.
@@ -703,18 +710,24 @@ that line. The SRCDIR variable in CMD's environment is set to the
 absolute path of the directory containing the interpreted novaboot
 script.
 
-Lines starting with C<copy> keyword are similar to C<load> lines. The
+=item C<copy>
+
+These lines are similar to C<load> lines. The
 file mentioned there is copied to the same place as in case of C<load>
 (e.g. tftp server), but the file is not used in the bootloader
 configuration. Such a file can be used by the target for other
 purposed than booting, e.g. at OS runtime or for firmware update.
 
+=item C<run>
+
 Lines starting with C<run> keyword contain shell commands that are run
 during file generation phase. This is the same as the "< CMD" syntax
 for C<load> keyboard except that the command's output is not
 redirected to a file. The ordering of commands is the same as they
 appear in the novaboot script.
 
+=item C<uboot>
+
 Lines starting with C<uboot> represent U-Boot commands that are sent
 to the target if B<--uboot> option is given. Having a U-Boot line in
 the novaboot script is the same as passing an equivalent
@@ -724,6 +737,8 @@ C<N> is the whole number of seconds. If the U-Boot command prompt does
 not appear before the timeout, novaboot fails. The default timeout is
 10 seconds.
 
+=back
+
 Example (Linux):
 
   #!/usr/bin/env novaboot

diff --git a/novaboot b/novaboot
index 01186490dbb4f88ad0db4cac38f5ccde32088c6d..49f846912c57dbe1cc9dd9075b09588feb6dffe2 100755 (executable)
--- a/novaboot
+++ b/novaboot
@@ -1894,7 +1894,14 @@ Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
 expression) assign values to internal variables. See L</VARIABLES>
 section.
 
-Lines starting with C<load> keyword represent modules to boot. The
+Otherwise, the first word on the line defines the meaning of the line.
+The following keywords are supported:
+
+=over 4
+
+=item C<load>
+
+These lines represent modules to boot. The
 word after C<load> is a file name (relative to the build directory
 (see B<--build-dir>) of the module to load and the remaining words are
 passed to it as the command line parameters.
@@ -1909,18 +1916,24 @@ that line. The SRCDIR variable in CMD's environment is set to the
 absolute path of the directory containing the interpreted novaboot
 script.
 
-Lines starting with C<copy> keyword are similar to C<load> lines. The
+=item C<copy>
+
+These lines are similar to C<load> lines. The
 file mentioned there is copied to the same place as in case of C<load>
 (e.g. tftp server), but the file is not used in the bootloader
 configuration. Such a file can be used by the target for other
 purposed than booting, e.g. at OS runtime or for firmware update.
 
+=item C<run>
+
 Lines starting with C<run> keyword contain shell commands that are run
 during file generation phase. This is the same as the "< CMD" syntax
 for C<load> keyboard except that the command's output is not
 redirected to a file. The ordering of commands is the same as they
 appear in the novaboot script.
 
+=item C<uboot>
+
 Lines starting with C<uboot> represent U-Boot commands that are sent
 to the target if B<--uboot> option is given. Having a U-Boot line in
 the novaboot script is the same as passing an equivalent
@@ -1930,6 +1943,8 @@ C<N> is the whole number of seconds. If the U-Boot command prompt does
 not appear before the timeout, novaboot fails. The default timeout is
 10 seconds.
 
+=back
+
 Example (Linux):
 
   #!/usr/bin/env novaboot