]> git.baikalelectronics.ru Git - uboot.git/commitdiff
doc: usage: Convert README.plan9 to reST
authorBin Meng <bmeng.cn@gmail.com>
Mon, 28 Mar 2022 02:43:51 +0000 (10:43 +0800)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Thu, 31 Mar 2022 17:06:16 +0000 (19:06 +0200)
This converts the existing README.plan9 to reST, and puts it under
the doc/usage/os directory.

Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
doc/README.plan9 [deleted file]
doc/usage/index.rst
doc/usage/os/plan9.rst [new file with mode: 0644]

diff --git a/doc/README.plan9 b/doc/README.plan9
deleted file mode 100644 (file)
index 2d3d0e0..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-Plan 9 from Bell Labs kernel images require additional setup to pass
-configuration information to the kernel.  An environment variable named
-confaddr must be defined with the same value as CONFADDR (see mem.h).
-Use of this facility is optional, but should be preferable to manual
-configuration.
-
-When booting an image, arguments supplied to the bootm command will be
-copied to CONFADDR.  If no arguments are specified, the contents of the
-bootargs environment variable will be copied.
-
-If no command line arguments or bootargs are defined, CONFADDR is left
-uninitialized to permit manual configuration.  For example, PC-style
-configuration could be simulated by issuing a fatload in bootcmd:
-
-  # setenv bootcmd fatload mmc 0 $confaddr plan9.ini; ...; bootm
-
-Steven Stallion
-June 2013
index a16deee145cb435c0f0c16fe5c7258f9f912a5e6..8a54d9cb03074f76eb0e7cbf9e57ad3b552ba958 100644 (file)
@@ -60,4 +60,5 @@ Booting OS
 .. toctree::
    :maxdepth: 1
 
+   os/plan9
    os/vxworks
diff --git a/doc/usage/os/plan9.rst b/doc/usage/os/plan9.rst
new file mode 100644 (file)
index 0000000..f91712c
--- /dev/null
@@ -0,0 +1,22 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. Steven Stallion
+.. June 2013
+
+Plan 9
+======
+
+Plan 9 from Bell Labs kernel images require additional setup to pass
+configuration information to the kernel.  An environment variable named
+confaddr must be defined with the same value as CONFADDR (see mem.h).
+Use of this facility is optional, but should be preferable to manual
+configuration.
+
+When booting an image, arguments supplied to the bootm command will be
+copied to CONFADDR.  If no arguments are specified, the contents of the
+bootargs environment variable will be copied.
+
+If no command line arguments or bootargs are defined, CONFADDR is left
+uninitialized to permit manual configuration.  For example, PC-style
+configuration could be simulated by issuing a fatload in bootcmd::
+
+  # setenv bootcmd fatload mmc 0 $confaddr plan9.ini; ...; bootm