From c9704ce7eccc62f913e125852f47e0455fe9fb3c Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Fri, 7 Oct 2022 20:51:35 +0200 Subject: doc: man-page for cls Provide a man-page for the cls command. Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- doc/usage/cmd/cls.rst | 26 ++++++++++++++++++++++++++ doc/usage/index.rst | 1 + 2 files changed, 27 insertions(+) create mode 100644 doc/usage/cmd/cls.rst (limited to 'doc') 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 -- cgit v1.3.1 From 627b0ba397e44a0ef0105c2ec5f0679c36b816a0 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sat, 8 Oct 2022 00:46:35 +0200 Subject: doc: add python3-filelock python3-pytest-xdist Packages python3-filelock python3-pytest-xdist as required to run 'make tests'. Add them to the required packages list in the documentation. Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- doc/build/gcc.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'doc') 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 ~~~~~~~~~~ -- cgit v1.3.1 From 88991b965f8343030a47d40287daa3b13a2dc212 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sat, 8 Oct 2022 01:19:22 +0200 Subject: doc: describe usage of virt-make-fs for testing We want tests to avoid the usage of sudo. Describe that virt-make-fs can generate disk images without being root. Signed-off-by: Heinrich Schuchardt --- doc/develop/py_testing.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'doc') 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.3.1