summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Rini <[email protected]>2022-10-10 12:14:51 -0400
committerTom Rini <[email protected]>2022-10-10 12:14:51 -0400
commit2877e9ddca83180ec1e3567f6bab3ffc380e0b60 (patch)
treedef195bf5f248d3950a9e6154567b4bf4c131e29 /doc
parent73e741b8ee46eba4e02a3bcc758dbd70540ed3c1 (diff)
parent21c4d7c5dddf7f51a4b8c11f94b8126278ff662e (diff)
Merge tag 'efi-2023-01-rc1-2' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request for efi-2023-01-rc1-2 Documentation: * man-page for cls command * update build requirements UEFI * Fix bugs in the Stop() function of the EFi Driver Binding protocol for block devices * Avoid EFI_CALL() when invoking CloseProtocol()
Diffstat (limited to 'doc')
-rw-r--r--doc/build/gcc.rst7
-rw-r--r--doc/develop/py_testing.rst19
-rw-r--r--doc/usage/cmd/cls.rst26
-rw-r--r--doc/usage/index.rst1
4 files changed, 50 insertions, 3 deletions
diff --git a/doc/build/gcc.rst b/doc/build/gcc.rst
index a71f860a487..a0650a51db4 100644
--- a/doc/build/gcc.rst
+++ b/doc/build/gcc.rst
@@ -27,10 +27,11 @@ Depending on the build targets further packages maybe needed
device-tree-compiler dfu-util efitools flex gdisk graphviz imagemagick \
liblz4-tool libgnutls28-dev libguestfs-tools libncurses-dev \
libpython3-dev libsdl2-dev libssl-dev lz4 lzma lzma-alone openssl \
- pkg-config python3 python3-asteval python3-coverage \
+ pkg-config python3 python3-asteval python3-coverage python3-filelock \
python3-pkg-resources python3-pycryptodome python3-pyelftools \
- python3-pytest python3-sphinxcontrib.apidoc python3-sphinx-rtd-theme \
- python3-subunit python3-testtools python3-virtualenv swig uuid-dev
+ python3-pytest python3-pytest-xdist python3-sphinxcontrib.apidoc \
+ python3-sphinx-rtd-theme python3-subunit python3-testtools \
+ python3-virtualenv swig uuid-dev
SUSE based
~~~~~~~~~~
diff --git a/doc/develop/py_testing.rst b/doc/develop/py_testing.rst
index 92fbd227219..6ff78103409 100644
--- a/doc/develop/py_testing.rst
+++ b/doc/develop/py_testing.rst
@@ -47,6 +47,7 @@ will be required. The following is an incomplete list:
* coreutils
* dosfstools
* efitools
+* guestfs-tools
* mount
* mtools
* sbsigntool
@@ -63,6 +64,24 @@ The test script supports either:
physical board, attach to the board's console stream, and reset the board.
Further details are described later.
+The usage of command 'sudo' should be avoided in tests. To create disk images
+use command virt-make-fs which is provided by package guestfs-tools. This
+command creates a virtual machine with QEMU in which the disk image is
+generated.
+
+Command virt-make-fs needs read access to the current kernel. On Ubuntu only
+root has this privilege. You can add a script /etc/initramfs-tools/hooks/vmlinuz
+with the following content to overcome the problem:
+
+.. code-block:: bash
+
+ #!/bin/sh
+ echo "chmod a+r vmlinuz-*"
+ chmod a+r /boot/vmlinuz-*
+
+The script should be chmod 755. It will be invoked whenever the initial RAM file
+system is updated.
+
Using `virtualenv` to provide requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/usage/cmd/cls.rst b/doc/usage/cmd/cls.rst
new file mode 100644
index 00000000000..b5c43e0a2e6
--- /dev/null
+++ b/doc/usage/cmd/cls.rst
@@ -0,0 +1,26 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+cls command
+===========
+
+Synopsis
+--------
+
+::
+
+ cls
+
+Description
+-----------
+
+The cls command clears the screen.
+
+Configuration
+-------------
+
+The cls command is only available if CONFIG_CMD_CLS=y.
+
+Return value
+------------
+
+The return value $? is 0 (true) on success and 1 (false) on failure.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 0fda121026e..d0641105ae4 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -32,6 +32,7 @@ Shell commands
cmd/button
cmd/bootz
cmd/cbsysinfo
+ cmd/cls
cmd/conitrace
cmd/cyclic
cmd/dm